Note: This feature is only available for sites with certain premium plans. If you need to use this feature, you can upgrade your site. Learn more about premium plans.
Wix allows users to connect an external database to Wix sites using an external database adaptor. Once the connection is set up, users can interact with these databases and use them to populate site elements as though they were Wix CMS collections.
With an external database adaptor, you can use your database hosted on GCP (Google Cloud Platform), and fully integrate it into your Wix site. This means your GCP data can be managed via the Wix Data APIs (REST|SDK), and used (with or without datasets) to populate Wix UI elements like repeatersand tables.
This article walks you through the following steps:
This tutorial assumes you already have your own database on GCP with a table containing some data. If you don't have this set up, refer to the GCP documentation for instructions.
This tutorial uses a container image with all the functionality needed to interface between your database and your Wix site. If you want to look under the hood, you can have a look at the service plugin specifications for external database collections, and an overview of what's involved in building your own adaptor.
Wix currently supports the following GCP databases:
Prerequisites for Read-Write Access to Your Database Tables:
If you want your table to be read-write on your Wix site, it must contain the following columns:
_id
_createdDate
_updatedDate
_owner
Tables without these columns will be read-only in your Wix site.
The external database adaptor requires you to set some environment variables. Some of these variables, like the DB credentials, are sensitive and shouldn't be visible. Use the GCP Secret Manager to store and access these variables securely.
Note: We don't provide specific instructions for any configuration in GCP, as GCP's UI and flows may change. For further details on any of the instructions below, see the Secret Manager documentation.
Store the following secret values for all databases:
A secret key that is used when connecting your Wix site to the adaptor. To create a level of authentication between your site and the adaptor, each request your site sends to the adaptor contains this value in the payload.
A JSON object that defines the read and write permissions for the tables in your database.
If you don't set permissions, they default to admin. With admin permissions, only site admins can read or write to the external database from a Wix site. API calls or CMS connections to the database don't work for anyone who isn't a site admin. This means site code that communicates with the external database might not work for site visitors.
When setting up permissions, make sure you use the ID of the table you want to read and write to, and not the database ID.
You can use the PERMISSIONS secret to customize the permission settings for each table in a database. The JSON object contains one key, collectionPermissions, whose value is an array of objects. Each object in this array contains the permissions settings for one of the collections in the database, using the following parameters:
Example PERMISSIONS value:
Note: You can save this object as a .json file and upload it to GCP as the value for the PERMISSIONS secret.
Customizing permissions for external databases is currently a developer preview feature, and may change. Changes to permissions settings aren't reflected in the editor.
In addition to the secrets above, each database requires its own specific secret configurations:
Make sure to create all of the required secrets for your database. All databases must include a SECRET_KEY.
To create the secrets, go to the GCP Secret Manager and create a secret with the appropriate configuration.
Database | Secret Configurations |
---|---|
MySQL, Postgres, and MsSQL | SECRET_KEY USER PASSWORD DB CLOUD_SQL_CONNECTION_NAME |
BigQuery | SECRET_KEY DATABASE_ID PROJECT_ID |
Spanner | SECRET_KEY INSTANCE_ID DATABASE_ID PROJECT_ID |
To create a PERMISSIONS secret, instead of entering a Secret value, provide the .json file that contains your permission settings.
Next, deploy the external database adaptor as a service on Cloud Run. To do this, you'll need to create the service using a prebuilt container, configured secrets, and environment variables. Then you'll need to configure the database connections.
For further details on any of the instructions below, see the Google Cloud Run documentation.
Create a new service for your cloud run project with the following configuration:
Enter the following as the Container Image URL:
The Service name will default to velo-external-db.
Select the All for Autoscaling, and select Allow unauthenticated invocations for Authentication.
Configure the secrets that you defined earlier as environment variables for the service. To do this, perform the following steps:
Create a new service account that will run the Cloud Run service.
Grant access roles to the new account.
Create environment variables and assign the secrets' values.
Set the Service account name. We recommend you set the Service account name to match the Cloud Run instance name so that you can easily know which account is used by which instance.
Grant the following roles to the service account according to your database:
All Databases:
MySQL, Postgres, MsSQL:
BigQuery:
Spanner:
Define 2 environment variables according to your database.
The names and values for the variables are as follows:
NAME | VALUE |
---|---|
TYPE | MySQL database: **mysql **Postgres database: postgres MsSQL server database: mssql BigQuery database: bigquery Spanner database: spanner |
CLOUD_VENDOR | Google Cloud Platform: gcp |
Make the secrets you configured and created in step 1 accessible to Cloud Run by adding the secrets information and exposing them as a environmental variables. Refer to the table above to see which secrets your database needs. For each secret, assign the environment variable the same name as the secret and ensure you've selected the latest version.
If you get a warning that the service account doesn't have permissions to access the selected secret, you are no longer configuring the service account that you set up in the previous steps.
Get the cloud run service's URL. This URL is used to connect to your database adaptor service and to configure the external collection on your Wix site.
Note: If you change the value of a secret, you must redeploy the service for the new value to take effect.
You can test that your service is working by making a quick request using Curl.
Use the Curl command below, replacing the URL with your URL from Step 2 above, and replacing the secretKey value with your secret.
The output provides a list of tables and their columns from your database. If you have python installed, you can pipe the output to python -m json.tool and it will give you nicely formatted JSON.
The formatted output contains the list of tables and their columns from your database.
Now that you have a database and an adaptor service, you're ready to add the database as an external collection on your site.
Note: You can only add external collections to your site if you have a premium plan.
Go to the Databases section of the Code sidebar (Wix Editor) or the Code sidebar (Wix Studio).
Click the icon next to External Databases and select Add external database.
Choose Google Cloud as the cloud provider of the external collection being added, then click Next.
Enter a name for your external collection's namespace.
Copy and paste your adaptor service's URL into the endpoint URL field.
Enter your database adaptor's secret key.
Click Connect.
The collection displays the tables. If your table contains the _id, _createdDate, _updatedDate, and _owner fields, you can add data to the table directly from the CMS.
Important: The CMS does not currently support deleting from external collections. You can delete records from your collection using Wix Data's remove()
method.
The external connection and its collections are displayed under External Databases.
You can now use the Wix Data API with this collection as well as connect repeaters and tables to your MySQL, Postgres, MsSQL, BigQuery, and Spanner databases.
Try the following Wix Javascript SDK code to query your external data using your collection name and table name:
Notes:
@wix/data
package on your site.