In this section we will show how to create a composite by downloading models from the model catalog.
You can fetch any existing model from the catalog by referencing the model’s unique ID. For example, for your basic social media app, use the existing model SimpleProfile. To fetch the model, to your working directory, take note of the model stream ID in the table above and run the following command:
composedb composite:from-model kjzl6hvfrbw6c5bf2jmwo9scp1ctkqvs5nru1jfjb1dgqqnf90sycptlztjdfep --ceramic-url=http://localhost:7007 --output=my-first-composite.json
composedb composite:from-model kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65 --ceramic-url=http://localhost:7007 --output=my-first-composite.json
You should see the following output in your terminal:
✔ Creating a composite from models... Composite was created and its encoded representation was saved in my-first-composite.json
This output means that you now have the SimpleProfile model stored locally in a file called my-first-composite.json.
If your application needs multiple models, for example the SimpleProfile and Post models, you can. To fetch them, take note of the model stream IDs and provide them in a ComposeDB CLI command as follows:
composedb composite:from-model kjzl6hvfrbw6c5bf2jmwo9scp1ctkqvs5nru1jfjb1dgqqnf90sycptlztjdfep kjzl6hvfrbw6c7gkodzmqq5s031yfo5xdllvcr1z0tumwl7kpml4gfe5gbwh2bg --ceramic-url=http://localhost:7007 --output=my-first-composite.json
composedb composite:from-model kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65 kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy --ceramic-url=http://localhost:7007 --output=my-first-composite.json
The output of this command will be a composite file named my-first-composite.json.
You will have to deploy the composite with fetched models to your local Ceramic node so that they can be used when building and running your applications. This can be achieved by using ComposeDB CLI and referencing the composite file of fetched models in your local environment as shown below. Note that you have to provide your did private key to deploy the model:
composedb composite:deploy my-first-composite.json --ceramic-url=http://localhost:7007 --did-private-key=your-private-key
You should see the output similar to the one below:
-ℹ Using DID did:key:z6MkoDgemAx51v8w692aZRLPdwP6UPKj3EgUhBTvbL7hCwLu
✔ Deploying the composite... Done!
["kjzl6hvfrbw6c5bf2jmwo9scp1ctkqvs5nru1jfjb1dgqqnf90sycptlztjdfep"]
ℹ Using DID did:key:z6MkoDgemAx51v8w692aZRLPdwP6UPKj3EgUhBTvbL7hCwLu
✔ Deploying the composite... Done!
["kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65"]
Whenever composites are deployed, the models will be automatically indexed. This also means that these models are shared across the network (at the moment, only Clay testnet). If you check the output produced by the terminal that runs your Ceramic local node, you should see a similar output:
-IMPORTANT: Starting indexing for Model kjzl6hvfrbw6c5bf2jmwo9scp1ctkqvs5nru1jfjb1dgqqnf90sycptlztjdfep
IMPORTANT: Starting indexing for Model kjzl6hvfrbw6c7gkodzmqq5s031yfo5xdllvcr1z0tumwl7kpml4gfe5gbwh2bg
IMPORTANT: Creating ComposeDB Indexing table for model: kjzl6hvfrbw6c5bf2jmwo9scp1ctkqvs5nru1jfjb1dgqqnf90sycptlztjdfep
IMPORTANT: Creating ComposeDB Indexing table for model: kjzl6hvfrbw6c7gkodzmqq5s031yfo5xdllvcr1z0tumwl7kpml4gfe5gbwh2bg
IMPORTANT: Starting indexing for Model kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65
IMPORTANT: Starting indexing for Model kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy
IMPORTANT: Creating ComposeDB Indexing table for model: kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65
IMPORTANT: Creating ComposeDB Indexing table for model: kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy
This means that the composite was deployed and the models were indexed on your local node successfully! 🎉
The last step left is compiling the composite. This is necessary to interact with the data in the next step of this guide:
diff --git a/docs/composedb/examples.html b/docs/composedb/examples.html index 61fcc8a9..e337bab3 100644 --- a/docs/composedb/examples.html +++ b/docs/composedb/examples.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/examples/tutorials-and-examples.html b/docs/composedb/examples/tutorials-and-examples.html index 92b49c27..bf396e44 100644 --- a/docs/composedb/examples/tutorials-and-examples.html +++ b/docs/composedb/examples/tutorials-and-examples.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/examples/verifiable-credentials.html b/docs/composedb/examples/verifiable-credentials.html index 0b4c4d92..8f4a7396 100644 --- a/docs/composedb/examples/verifiable-credentials.html +++ b/docs/composedb/examples/verifiable-credentials.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/getting-started.html b/docs/composedb/getting-started.html index 0771ed1f..f5a1ab67 100644 --- a/docs/composedb/getting-started.html +++ b/docs/composedb/getting-started.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides.html b/docs/composedb/guides.html index fbc2a099..32c0edd7 100644 --- a/docs/composedb/guides.html +++ b/docs/composedb/guides.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-client.html b/docs/composedb/guides/composedb-client.html index ba9859dc..b678cdec 100644 --- a/docs/composedb/guides/composedb-client.html +++ b/docs/composedb/guides/composedb-client.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-client/authenticate-users.html b/docs/composedb/guides/composedb-client/authenticate-users.html index 64fbf2cd..1a7977aa 100644 --- a/docs/composedb/guides/composedb-client/authenticate-users.html +++ b/docs/composedb/guides/composedb-client/authenticate-users.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-client/javascript-client.html b/docs/composedb/guides/composedb-client/javascript-client.html index f2c8f8e5..03c711e9 100644 --- a/docs/composedb/guides/composedb-client/javascript-client.html +++ b/docs/composedb/guides/composedb-client/javascript-client.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-client/user-sessions.html b/docs/composedb/guides/composedb-client/user-sessions.html index 9e66ca45..ba6fb378 100644 --- a/docs/composedb/guides/composedb-client/user-sessions.html +++ b/docs/composedb/guides/composedb-client/user-sessions.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-client/using-apollo.html b/docs/composedb/guides/composedb-client/using-apollo.html index 27ac7c54..14e5156f 100644 --- a/docs/composedb/guides/composedb-client/using-apollo.html +++ b/docs/composedb/guides/composedb-client/using-apollo.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-client/using-relay.html b/docs/composedb/guides/composedb-client/using-relay.html index 10c6ddd9..1c8cd6f5 100644 --- a/docs/composedb/guides/composedb-client/using-relay.html +++ b/docs/composedb/guides/composedb-client/using-relay.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-server.html b/docs/composedb/guides/composedb-server.html index ce0248e7..beaf7595 100644 --- a/docs/composedb/guides/composedb-server.html +++ b/docs/composedb/guides/composedb-server.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-server/access-mainnet.html b/docs/composedb/guides/composedb-server/access-mainnet.html index a42cf2f3..6cc54ef4 100644 --- a/docs/composedb/guides/composedb-server/access-mainnet.html +++ b/docs/composedb/guides/composedb-server/access-mainnet.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-server/data-storage.html b/docs/composedb/guides/composedb-server/data-storage.html index e5db7ed4..e1a2da0a 100644 --- a/docs/composedb/guides/composedb-server/data-storage.html +++ b/docs/composedb/guides/composedb-server/data-storage.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-server/running-in-the-cloud.html b/docs/composedb/guides/composedb-server/running-in-the-cloud.html index ccf25b89..f615f706 100644 --- a/docs/composedb/guides/composedb-server/running-in-the-cloud.html +++ b/docs/composedb/guides/composedb-server/running-in-the-cloud.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-server/running-locally.html b/docs/composedb/guides/composedb-server/running-locally.html index 72c9bb9b..b43b0f33 100644 --- a/docs/composedb/guides/composedb-server/running-locally.html +++ b/docs/composedb/guides/composedb-server/running-locally.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/composedb-server/server-configurations.html b/docs/composedb/guides/composedb-server/server-configurations.html index c34a90e3..de06623b 100644 --- a/docs/composedb/guides/composedb-server/server-configurations.html +++ b/docs/composedb/guides/composedb-server/server-configurations.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/data-interactions.html b/docs/composedb/guides/data-interactions.html index 6d651ef7..90df5c20 100644 --- a/docs/composedb/guides/data-interactions.html +++ b/docs/composedb/guides/data-interactions.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/data-interactions/mutations.html b/docs/composedb/guides/data-interactions/mutations.html index 1a1eb49d..cfe6e2eb 100644 --- a/docs/composedb/guides/data-interactions/mutations.html +++ b/docs/composedb/guides/data-interactions/mutations.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/data-interactions/queries.html b/docs/composedb/guides/data-interactions/queries.html index a1e329b1..de764f80 100644 --- a/docs/composedb/guides/data-interactions/queries.html +++ b/docs/composedb/guides/data-interactions/queries.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/data-modeling.html b/docs/composedb/guides/data-modeling.html index b407c6ce..2976e8a2 100644 --- a/docs/composedb/guides/data-modeling.html +++ b/docs/composedb/guides/data-modeling.html @@ -13,7 +13,7 @@ - + diff --git a/docs/composedb/guides/data-modeling/composites.html b/docs/composedb/guides/data-modeling/composites.html index 389f0bd7..3df1e7b4 100644 --- a/docs/composedb/guides/data-modeling/composites.html +++ b/docs/composedb/guides/data-modeling/composites.html @@ -13,7 +13,7 @@ - + @@ -64,7 +64,7 @@In cases where your composite contain models not needed by your application, or in other cases where you generally want to separate models in your composite, you can extract models into a separate composite.
As an example, let’s reuse the merged-composite.json file from the previous section and assume you want to extract the profile model into a separate composite. To do this, load the merged-composite.json file and specify which model(s) you’d like to extract into a new composite file.
composedb composite:extract-model merged-composite.json kjzl6hvfrbw6c7keo17n66rxyo21nqqaa9lh491jz16od43nokz7ksfcvzi6bwc --output=new-composite.json
import { CeramicClient } from '@ceramicnetwork/http-client'
import { Composite } from '@composedb/devtools'
import { readEncodedComposite, writeEncodedComposite } from '@composedb/devtools-node'
const ceramic = new CeramicClient('http://localhost:7007')
const sourceComposite = await readEncodedComposite(ceramic, 'merged-composite.json')
const mergedComposite = sourceComposite.copy(['kjzl6hvfrbw6c7keo17n66rxyo21nqqaa9lh491jz16od43nokz7ksfcvzi6bwc'])
await writeEncodedComposite(mergedComposite, 'new-composite.json')
composedb composite:extract-model merged-composite.json kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65 --output=new-composite.json
import { CeramicClient } from '@ceramicnetwork/http-client'
import { Composite } from '@composedb/devtools'
import { readEncodedComposite, writeEncodedComposite } from '@composedb/devtools-node'
const ceramic = new CeramicClient('http://localhost:7007')
const sourceComposite = await readEncodedComposite(ceramic, 'merged-composite.json')
const mergedComposite = sourceComposite.copy(['kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65'])
await writeEncodedComposite(mergedComposite, 'new-composite.json')
This will create a file called new-composite.json with your profile model in it. From here you need to deploy the composite to your node, then compile the composite to start using it.
If you want to check what models are included in a specific composite, follow the steps below:
@@ -81,11 +81,11 @@In general, models are referenced using their unique model streamIDs which are not memorable. Models can be more easily referenced by aliasing them to your preferred names.
To manually set aliases for your models, add the following section to your composite JSON file. In this case we will use the aliases SimpleProfile and Post.
"aliases":{
"kjzl6hvfrbw6c7keo17n66rxyo21nqqaa9lh491jz16od43nokz7ksfcvzi6bwc":"SimpleProfile",
"kjzl6hvfrbw6c99mdfpjx1z3fue7sesgua6gsl1vu97229lq56344zu9bawnf96":"Post"
}
"aliases":{
"kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65":"SimpleProfile",
"kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy":"Post"
}
To do aliases programmatically, use the ComposeDB Devtools library. Here’s an example script that loads a composite JSON file and assigns SimpleProfile and Post:
import { CeramicClient } from '@ceramicnetwork/http-client'
import { Composite } from '@composedb/devtools'
import { readEncodedComposite, writeEncodedComposite } from '@composedb/devtools-node'
const ceramic = new CeramicClient('http://localhost:7007')
const sourceComposite = await readEncodedComposite(ceramic, 'merged-composite.json')
const newComposite = sourceComposite.setAliases({
'kjzl6hvfrbw6c7keo17n66rxyo21nqqaa9lh491jz16od43nokz7ksfcvzi6bwc': 'SimpleProfile',
'kjzl6hvfrbw6c99mdfpjx1z3fue7sesgua6gsl1vu97229lq56344zu9bawnf96': 'Post',
})
await writeEncodedComposite(newComposite, 'new-composite.json')
import { CeramicClient } from '@ceramicnetwork/http-client'
import { Composite } from '@composedb/devtools'
import { readEncodedComposite, writeEncodedComposite } from '@composedb/devtools-node'
const ceramic = new CeramicClient('http://localhost:7007')
const sourceComposite = await readEncodedComposite(ceramic, 'merged-composite.json')
const newComposite = sourceComposite.setAliases({
'kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65': 'SimpleProfile',
'kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy': 'Post',
})
await writeEncodedComposite(newComposite, 'new-composite.json')
This script will create a file named new-composite.json including model aliases:
"aliases":{
"kjzl6hvfrbw6c7keo17n66rxyo21nqqaa9lh491jz16od43nokz7ksfcvzi6bwc":"SimpleProfile",
"kjzl6hvfrbw6c99mdfpjx1z3fue7sesgua6gsl1vu97229lq56344zu9bawnf96":"Post"
}
"aliases":{
"kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65":"SimpleProfile",
"kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy":"Post"
}
From here you need to deploy the composite to your node, then compile the composite to start using it. When interacting with the models inside your app, you can refer to them using their human-readable aliases rather than their streamIDs.
Fetch a single model from the catalog and convert it into a composite, using its model ID:
-composedb composite:from-model kjzl6hvfrbw6c7keo17n66rxyo21nqqaa9lh491jz16od43nokz7ksfcvzi6bwc --output=my-composite.json
composedb composite:from-model kjzl6hvfrbw6c5i55ks5m4hhyuh0jylw4g7x0asndu97i7luts4dfzvm35oev65 --output=my-composite.json
Run the composite:from-model command depicted above for each model you want to use in your application. Remember to change the composite file name to avoid collisions. After you have multiple composite files, merge them. See Merging Composites.
There is type of model-to-model relation that includes the user as part of the relationship. This is achieved by using the SET account relation type, which allows users to enforce a constraint where each user account (or DID) can create only one instance of a model for a specific record of another model.
Here’s a model that allows many comments from the same or different account to be made on a single post. It supports unlimited comments per user, and bi-directional queries from any comment or like to the original post and from the original post to all of its comments and likes. The model schema also creates a relation between posts and likes enabling a single like per post by an account, meaning a single account will only be able to like the post once
-# Load post model (using streamID)
type Post @loadModel(id: "kjzl6hvfrbw6c99mdfpjx1z3fue7sesgua6gsl1vu97229lq56344zu9bawnf96") {
id: ID!
}
# New comment model
# Set reference to original post
# Enable querying comment to get original post
type Comment @createModel(accountRelation: LIST, description: "A comment on a Post") {
postID: StreamID! @documentReference(model: "Post")
post: Post! @relationDocument(property: "postID")
text: String! @string(maxLength: 500)
}
# New like model
# Set relationship to original post
# Enable querying comment to get original post
type Like @createModel(description: "A like on a post", accountRelation: SET, accountRelationFields: ["postID"]) {
postID: StreamID! @documentReference(model: "Post")
post: Post! @relationDocument(property: "postID")
}
# Load post model (using streamID)
type Post @loadModel(id: "kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy") {
id: ID!
}
# New comment model
# Set reference to original post
# Enable querying comment to get original post
type Comment @createModel(accountRelation: LIST, description: "A comment on a Post") {
postID: StreamID! @documentReference(model: "Post")
post: Post! @relationDocument(property: "postID")
text: String! @string(maxLength: 500)
}
# New like model
# Set relationship to original post
# Enable querying comment to get original post
type Like @createModel(description: "A like on a post", accountRelation: SET, accountRelationFields: ["postID"]) {
postID: StreamID! @documentReference(model: "Post")
post: Post! @relationDocument(property: "postID")
}
Relations can also be created between models loaded from known streamIDs
-# Load comment model
type Comment @loadModel(id: "kjzl6hvfrbw6c9oo2ync09y6z5c9mas9u49lfzcowepuzxmcn3pzztvzd0c7gh0") {
id: ID!
}
# Load post model
# Extend post model with comments and likes
# Set relationships to all comments and likes
# Enable querying post to get all comments and likes
type Post @loadModel(id: "kjzl6hvfrbw6c99mdfpjx1z3fue7sesgua6gsl1vu97229lq56344zu9bawnf96") {
comments: [Comment] @relationFrom(model: "Comment", property: "postID")
likes: [Like] @relationFrom(model: "Like", property: "postID")
}
# Load comment model
type Comment @loadModel(id: "kjzl6hvfrbw6c9oo2ync09y6z5c9mas9u49lfzcowepuzxmcn3pzztvzd0c7gh0") {
id: ID!
}
# Load post model
# Extend post model with comments and likes
# Set relationships to all comments and likes
# Enable querying post to get all comments and likes
type Post @loadModel(id: "kjzl6hvfrbw6c822s0cj1ug59spj648ml8a6mbqaz91wx8zx3mlwi76tfh3u1dy") {
comments: [Comment] @relationFrom(model: "Comment", property: "postID")
likes: [Like] @relationFrom(model: "Like", property: "postID")
}
Where:
id is a simple placeholder, since empty types are not allowedceramic-one using the following command:ceramic-one daemon
By default, the command above will spin off a node which connects to a clay-testnet network. You can change this behaviour by providing a --network flag and specifying a network of your choice. For example:
ceramic-one daemon --network clay-testnet
By default, the command above will spin off a node which connects to a testnet-clay network. You can change this behaviour by providing a --network flag and specifying a network of your choice. For example:
ceramic-one daemon --network testnet-clay
By default ceramic-one will store its data in the current directory. You can configure this behaviour by
specifying the --store-dirand --p2p-key-dir arguments. For example:
ceramic-one daemon --store-dir ~/.ceramic-one --p2p-key-dir ~/.ceramic-one