createExternalDatabaseConnection( )


Creates a new external database connection.

Before you can establish a connection between a site and an external database, you must prepare an external database adaptor.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage External Database Connections
Manage All Data Resources
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
externalDatabaseConnectionExternalDatabaseConnectionRequired

External database connection details.


connectionTypeConnectionTypeRequired

Connection type. The connection type specifies the type of adaptor by which the external collection is integrated with the site.


optionsCreateExternalDatabaseConnectionOptions

Options for creating an external database connection.

Returns
Return Type:Promise<ExternalDatabaseConnection>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?