The External Database Connections API enables you to connect an external database to the Wix site on which your app is installed.
Wix provides a comprehensive full-stack platform with integrated database capabilities. Your app can use the Data Collections API to create, modify, and delete data collections in a Wix site on which it is installed. The app can then use the Data Items API to access and manage data within those collections.
Wix's database capabilities cover a wide range of use cases for apps that need to store data. However, certain projects have very specific requirements that make it necessary to use an external database. For example, you may need to access existing data that is already stored on an external service, or you may need your data to be stored in a relational database.
Once the connection between an external database and a Wix site is established, your app can access the collection using Wix Data APIs, including the Data Items API, in the same way you would with a native collection. The owner of the Wix site on which your app is installed can also access the collection through the Content Management System(CMS) and with Velo, use the collection to create dynamic pages, and connect the collection to user input elements.
For more information on connecting external databases with a Wix site, see Integrating External Databases with Your Wix Site.
Before the External Database Connections API can connect a Wix site with an external database, you need to prepare the external database by creating an external database adaptor.
An external database adaptor is a server that translates Wix data requests from a Wix site or app into an external database's protocol, and translates the response back into a format that Wix APIs can read. This enables Wix APIs, apps, and sites to treat the external database exactly as if it was an internal data collection.
If your database is hosted on one of the major cloud platforms, you can consult one of our tutorials for instructions on how to deploy an external database adaptor.
Otherwise, for details on the required specifications for an external database adaptor, see the External Database Collections SPI.
If you want to enable read-write access to your external database using the Data Items API, ensure your external database's table or schema includes the following fields:
_id_createdDate_updatedDate_ownerIf these fields are absent, access to the external database is read-only. You may prefer this option for data that your app only needs to retrieve and doesn't need to manage.
The External Database Connections API works with several kinds of databases. For a full list, see Supported Databases.
Retrieves an external database connection by name.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Deletes an external database connection.
Note: Once an external database connection is deleted, it can't be restored. To reconnect the database you need to create a new external database connection.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves a list of all external database collections associated with the site or project.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Creates a new external database connection.
The request body must include a name, base URL, and configuration details for the external database within the externalDatabaseConnection body parameter.
If any of these are missing, the external database connection isn't created.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Updates an external database connection.
An external database collection name must be submitted as a path parameter. If an existing external database connection is found with the same name, that connection's details are updated. If no external database connection has that name, the request fails.
Note: After an external database connection is updated, it only contains the values provided in the request. All previous values are lost.