External databases
External databases allow developers to integrate different database types with their IoT Platform application. You should recreate and access your external database connections using the new API (collection connections 9.0.0 version). Any new external databases created must use the new ClearBlade.Database
interface only. Connect collections created before the 9.0.0 version are external databases and can use the ClearBlade.Collection
and ClearBlade.Database
library interface.
Please create a support ticket to request integrations.
Adding an external database
Click + Add External Database, and a modal should appear. Enter the information from the database that you will be using. Not all database types will have the same settings fields. The standard settings fields for all database types are Database Name, IP Address, Port, Username, and Password. Oracle, DB2_Linux, DB2_zOS, DB2_System_i, and Cassandra are currently only supported in on-premise installations.
MongoDB example
![](../__attachments/2343895055/image-20230407-162244.png?inst-v=00a7a7be-0508-4b6c-9dbe-8063c38bb43c)
Permissions are needed to execute operations in the external database terminal.
![](../__attachments/2343895055/db_perm.png?inst-v=00a7a7be-0508-4b6c-9dbe-8063c38bb43c)
Viewing the terminal
A terminal is available for your database commands and to execute operations against the connection. Results can be shown side-by-side with a JSON viewer when the Show JSON? box is checked.
![](../__attachments/2343895055/db_terminal.png?inst-v=00a7a7be-0508-4b6c-9dbe-8063c38bb43c)
Deleting the external database
Delete External Database can be found under the terminal. Click Confirm in the modal.