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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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.

Returns
Return Type:Promise<ExternalDatabaseConnection>
JavaScript
Errors

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

Did this help?