Defining your schema - Developer

User guides Developer website

Search…

Defining your schema

​Schemas are associated with datamarts by managing objects with the following properties: 
Make sure you learned about schema's concepts and how they are structured.
1
// DRAFT Schema
2
{
3
    "id": "1385",
4
    "datamart_id": "1509",
5
    "status": "DRAFT",
6
    "creation_date": 1609888013947,
7
    "last_modification_date": 1610443926552,
8
    "publication_date": null,
9
    "suspension_date": null
10
}
11
​
12
// LIVE Schema
13
{
14
    "id": "1281",
15
    "datamart_id": "1509",
16
    "status": "LIVE",
17
    "creation_date": 1603198414771,
18
    "last_modification_date": 1603198415117,
19
    "publication_date": 1603198415733,
20
    "suspension_date": null
21
}
22
        
23
// ARCHIVED Schema
24
{
25
    "id": "1276",
26
    "datamart_id": "1509",
27
    "status": "ARCHIVED",
28
    "creation_date": 1603102827888,
29
    "last_modification_date": 1603102828087,
30
    "publication_date": 1603102828479,
31
    "suspension_date": 1603102848269
32
}
Copied!
Schema publication workflow
The process for publishing a schema is as follows:
1.Create a new schema definition
2.Upload the schema associated with the definition
3.Validate the schema
4.Publish the schema
Schema updates
After updating a schema, you can immediately use all its properties into the select part of your OTQL queries and any operator that doesn't require indexing.
If you add a new indexed property, only new elements going into your datamart will be indexed. You will be able to run WHERE queries and operators needing indexing, but your queries will not return values for elements already in your datamart. You can add a new indexed property by either adding a new property with @TreeIndex directive or adding the @TreeIndex directive to an existing property.
If you remove an indexed property, you will instantly stop being able to run WHERE queries and operators needing indexing for this query.
You can ask your mediarithmics contact to start a complete reindexing of your datamart if required
Manage schemas with mics CLI
You can use the MICS CLI to power up your schema definitions workflow. 
Download a schema
Retrieve the LIVE schema or the specified one for a given datamart, and save it as a .gql file named schema-<DATAMARTID>-<SCHEMAID>.gql.
Use it to download the schema you want to start with, usually the current LIVE version.
1
USAGE
2
  $ mics-cli schema:fetch DATAMARTID [SCHEMAID]
3
​
4
ARGUMENTS
5
  DATAMARTID  the ID of the datamart
6
  SCHEMAID    [default: LIVE] the ID of the schema, or LIVE to get the live schema
7
​
8
OPTIONS
9
  --stdout  output the content of the file instead of saving it in a file
Copied!
If you want to show the schema in the output, use the --stdout flag.
Update a schema
Create a draft, upload a file, validate it, and publish the schema with this all-in-one command. 
Automatically handles status and cloning best practices: 
If a draft schema already exists, update it before publishing.
Latest LIVE schema is cloned, if available, and --noClone flag is not set
You can keep your schema as a DRAFT and not publish it using  the --skipPublishflag. 
get
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas
Get existing schemas
Archived schemas are displayed, meaning you can watch your history
get
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas/:schemaId
Get a schema
get
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas/:schemaId/text
Get the content of a schema
post
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas/:schemaId/clone
Create a DRAFT by cloning
This is the preferred method to create a DRAFT schema, as it will keep all settings from the previous version, like cluster versions, and index sizes.
post
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas
Create a DRAFT without cloning
For the schema to keep initial settings—for example, elastic search version, and index size—you need to clone the previous LIVE version. Only use this endpoint if you know the required settings and you can set them up before publishing.
put
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas/:schemaId/text
Upload the content
post
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas/:schemaId/validation
Validate a DRAFT schema
post
https://api.mediarithmics.com
/v1/datamarts/:datamartId/graphdb_runtime_schemas/:schemaId/publication
Publish a schema
​

Last modified 1yr ago

Copy link

Contents

Schema publication workflow

Manage schemas with mics CLI

Download a schema

Update a schema

Get existing schemas

Get the content of a schema

Create a DRAFT by cloning

Create a DRAFT without cloning

Upload the content

Validate a DRAFT schema

Publish a schema