Add a Data Collections Extension with the Wix CLI

The data collections extension lets your app automatically create data collections in a site's CMS. When a Wix user installs or updates your app, the collections are created with the configuration you define.

Follow the instructions below to:

1. Generate the extension and 1 or more collections in your project.
2. Configure each collection's schema, permissions, and initial data.
3. Release a new app version so the collections are created on installed sites.

Once complete, your app automatically creates the specified collections in the CMS whenever a Wix user installs or updates it.

Step 1 | Create the extension

In the terminal:

1. Navigate to your project repo.
2. Run the generate command.
3. The CLI displays a menu of extensions to generate. Under Backend, select Data Collection and press Enter.
4. Enter a collection name when prompted. The name must be 1–36 characters and can only contain letters, numbers, underscores, and hyphens. The name must also be unique in the data collections extension folder.

The first time you run this command, the CLI creates the shared extension file (data-collections.extension.ts) alongside the new collection's definition file. Subsequent runs add new collection definition files to the same shared extension and register them automatically.

Step 2 | Configure the collection

Each collection is defined in its own <your-collection-name>.ts file. The default export is an object that describes the collection's schema, permissions, indexes, and initial data. The object follows the schema documented in the data collections extension JSON reference.

You can add multiple collections with the generate command. The CLI generates each collection with default fields and permissions. Edit each collection's <your-collection-name>.ts file to fit your data model.

Learn more about data collections extension files and code.

Step 3 | Build and deploy your project

Release a new app version, then build and deploy your project. Learn more about app version updates.

Delete a collection or the entire extension

To delete a single collection from your extension:

1. Delete the collection's <your-collection-name>.ts file.
2. In data-collections.extension.ts, delete the matching import statement and the entry for that collection from the collections array.

To delete the entire data collections extension:

1. Delete the src/extensions/backend/data-collections/ folder.
2. Delete the import and .use() statements for the extension from your extensions.ts file.

See also

• Data Collections Extension Files and Code
• About Data Collections Extensions
• Add a Data Collections Extension in the App Dashboard
• Data Collections Extension JSON Reference
• About the Wix Data Collections API