updateExternalDatabaseConnection( )

Updates an external database connection.

Note: After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.

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
namestringRequired

Name of the external database connection.

An external database connection can connect to one or more external data collections or tables. These appear as connectionName/dataCollectionId.

externalDatabaseConnectionUpdateExternalDatabaseConnectionRequired

Updated external database connection details. The existing connection is replaced with this version.

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?