Create the composite

reference: Ceramic Docs - Create your composite

A composite is your database schema for ComposeDB, which includes a collection of data models. Once created, your composite instructs your node which models to index and also allows your client to perform queries and mutations on these models.

To create composites in your application, you have two routes to choose from:

Loading an Existing Model Using a Model ID
Creating a Composite from a GraphQL File

Loading an Existing Model Using Model ID

To load an existing model into your working directory using its unique model ID, follow these steps:

Fetch the Model: Run the command below, replacing the <model-id> with your specific model ID. Here's a previously deployed Nova test model: kjzl6hvfrbw6c7c9c35xsdcnzle6fqmc97f9kniqanxudbrb10xg78hul55dhfb
```
composedb composite:from-model kjzl6hvfrbw6c7c9c35xsdcnzle6fqmc97f9kniqanxudbrb10xg78hul55dhfb --ceramic-url=http://localhost:7007 --output=evp-report-template.json
```
This command will fetch the model from Ceramic and save it locally as evp-report-template.json.
Verify the Output: You should see confirmation in your terminal similar to:
```
✔ Creating a composite from models... Composite was created and its encoded representation was saved in my-first-composite.json
```
You now have the model stored locally and ready for use in your project.

Creating a Composite from a GraphQL File

If you prefer to create a composite from scratch using a custom GraphQL schema, there are two methods: using the command line directly or via a script. Below are the instructions for both approaches.

Option A: Using Command Line

Prepare Your GraphQL File: Ensure your GraphQL file (evp-report-template.graphql) is located in your working directory inside the ./composites folder.

Create the Composite: Use the command below to create the composite from the GraphQL file:

composedb composite:compile ./composites/evp-report-template.graphql --output=evp-report-template-composite.json --did-private-key=your-private-key

Replace your-private-key with the private admin key from the DID you generated during authentication. This command compiles the GraphQL schema into a composite and saves the encoded output as evp-report-composite.json.

Option B: Using a Script

Script Setup: Ensure you have a script named create-composite.js inside your api-nova/scripts directory that includes the command to create the composite.
Run the Script: Execute the script to compile and create the composite:
```
node scripts/create-composite.js
```
The script should include the command to compile the GraphQL file, similar to:

// insert outputs

Ensure to replace your-private-key with the private admin key from your DID. The script will compile the GraphQL schema into a composite and output evp-report-composite.json.

PreviousComposites NextUsing the Composite

Last updated 1 year ago