Skip to main content

Defining Models with Collect SDK

note

In this section, we focus on how to define models using the Collect SDK. Defining models accurately is crucial as it not only aids in validating the fields according to the schema but also enhances the developer experience with features like autocomplete and field name suggestions.

Table of Contents​

Understanding CollectSchema​

The CollectSchema is at the core of model definitions in Collect. It specifies the structure and constraints of the data fields within your model. Here's a breakdown of the properties you can define within a CollectSchema:

type CollectSchema = Record<string, {
    default?: CollectSchemaDefaultValue;
    multiple?: boolean;
    required?: boolean;
    type: CollectPropertyType;
    uniq?: boolean;
}>;

Schema Properties Explained:

  • default: This is the initial value of the field if no value is provided during record creation. It can be a static value or a function that returns a value asynchronously, allowing for dynamic default values.
  • multiple: Indicates whether the field can hold multiple values (array) or just a single value.
  • required: Specifies whether a field is mandatory. If set to true, you cannot create a record without providing a value for this field.
  • type: Defines the data type of the field. The type determines the available search operators and how data is validated and stored. Possible types include:
    • boolean
    • datetime (can be either a detailed object or an ISO string)
    • null
    • number
    • string
  • uniq: If set to true, the field must have a unique value across all records in the database, useful for fields like email addresses or custom identifiers.

Creating a Model with CollectModel​

With an understanding of CollectSchema, you can define a model in the Collect system. Here’s how to define a simple Author model:

const Author = new CollectModel('author', {
  name: { type: 'string' },
  email: { type: 'string', uniq: true }
});

CollectModel Constructor Parameters:

  • modelName: A unique string identifier for the model. It's used to reference the model within the SDK and to associate records with their corresponding model type in the database.
  • schema: The schema definition based on CollectSchema, which dictates the structure and rules of the data stored.
  • relationships (optional): Defines how this model relates to other models, which is essential for establishing connections between different data types:
type CollectRelations = Record<string, {
    model: string;
}>;

Registering and Managing Models​

Once you define a model, you must register it with the Collect SDK to make it operational:

const AuthorRepo = Collect.registerModel(Author);

Working with Models in Collect class:

  • registerModel: Registers the model with the Collect SDK, making it ready for data operations:
  • getModel and getModels: Retrieve registered models from the SDK, useful for accessing model details programmatically:
  public getModel(label: string): CollectModel
  public getModels(): Map<string, CollectModel>

Conclusion​

Defining models with CollectModel and CollectSchema sets a robust foundation for your application's data architecture. It enables strong type-checking, validation, and inter-model relationships, enhancing the robustness and scalability of your applications. In subsequent sections, we will explore how to interact with these models to create, retrieve, update, and delete records.