Schema
This topic describes how to create custom objects and fields for your app using Optimizely Data Platform (ODP) and Optimizely Connect Platform (OCP).
The Basics
Term | Definition |
|---|---|
Object | Objects are database tables, acting as collections of client data. Objects contain fields that are the names of the table columns. Objects are connected to other objects via relationships. |
Field | Fields are columns within the table (an Object within OCP). All objects have one primary key field that must be a string or number. Fields have a data type and can be
|
Relationship | Relationships are database table relationships. |
Important
All objects and fields that are unique to your app must be prefixed with your
app_id.
For example, if yourapp_idis acme, you must prefix all of your objects and fields on objects you created with acme.The exception to this is fields within an object that your app create (for example, if your app created
acme_ticketsthen you do not have to prefix fields within this object).
Create Static Schema
All files within src/schema are parsed at install time and described objects and fields are created.
Note
The file names of files within
src/schemamust match the name of an existing object or the name of the newly created object you wish to create.
name: acme_tickets
display_name: Acme Tickets
alias: acme_ticket
fields:
- name: acme_ticket_id
display_name: Acme Ticket ID
type: string
primary: true
- name: tag_id
display_name: Tag ID
type: string
relations:
- name: acme_ticket_tag
display_name: Acme Ticket Tag
child_object: acme_ticket_tags
join_fields:
- parent: tag_id
child: acme_ticket_tag_id
Property | |
|---|---|
name | The name of object (should be plural) |
display_name | The user-friendly name used for display within the UI (should be plural) |
alias | The singular name of the object |
fields.name | The name of the field used for API/SDK calls, CSV uploads and Liquid |
fields.display_name | The user-friendly name used for display within the UI |
fields.type | One of |
fields.primary | Boolean. Optional. Defaults to Whether or not the field listed is the primary key for the containing object. At least one primary key is required for new objects! |
relations | Optional. Should be defined on the parent object. |
relations.name | The name of the relationship used for API/SDK calls and Liquid. |
relations.display_name | The user-friendly name used for display within the UI. |
relations.child_object | The child object that is connected to this object. |
relations.join_fields.parent | Any field on this object that you want to relate to another object. |
relations.join_fields.child | Must be a primary key on the child object. |
Create Dynamic Schema
(For example, custom fields per client)
You often need to create fields that are client-specific. These objects and fields cannot be created via the Schema .yml files because they differ for each install. OCP provides a number of methods to create fields programmatically.
Find the latest SDK reference in our reference for Fields, Objects & Relationships.
import {z} from '@zaius/node-sdk';
z.schema.createObject({
'name': 'acme_tickets',
'display_name': 'Acme Tickets',
'alias': 'acme_ticket',
'fields': [
{
'name': 'acme_ticket_id',
'display_name': 'Acme Ticket ID',
'type': 'string',
'primary': true
},{
'name': 'tag_id',
'display_name': 'Tag ID',
'type': 'string'
}
],
'relations': [
{
'name': 'acme_ticket_tag',
'display_name': 'Acme Ticket Tag',
'child_object': 'acme_ticket_tags',
'join_fields': [{
'parent': 'tag_id',
'child': 'acme_ticket_tag_id'
}]
}
]
});
import {z} from '@zaius/node-sdk';
z.schema.createField('acme_tickets', {
'name': 'tag_id',
'display_name': 'Tag ID',
'type': 'string'
});
import {z} from '@zaius/node-sdk';
z.schema.createRelation('acme_tickets', {
'name': 'acme_ticket_tag',
'display_name': 'Acme Ticket Tag',
'child_object': 'acme_ticket_tags',
'join_fields': [{
'parent': 'tag_id',
'child': 'acme_ticket_tag_id'
}]
});
Updated 4 months ago