Skip to main content

Schema development

Depot data object design is driven by the Basestar YAML schema format. Various data objects are defined using this format. For example:

  • Objects
  • Views
  • Records
  • Structs
  • Sequences
  • Queries
  • User Defined Functions (UDFs)
petstore.Order:
  type: object
  properties:
    storeName:
      type: string
    customerId:
      type: string
    petId:
      type: string

Although Depot works with YAML and JSON defined schema, and the depot-package-common module provides convenience methods around loading schema definitions from YAML, it is still possible to wrap schema language and concepts in covenience layers and tooling to assist in your own development practices.

info

At the moment Depot has quite good support for Typescript schemas(depot-package-common) and SQL schemas in drizzle(look at matching repository) . If you have a need for other schema types, please feel free to raise a pr.

Furthermore, Depot schemas can be automatically augmented with other features such as TypeScript integration for JavaScript UDFs, or separate SQL and Stored Procedure integration.

For the complete schema documentation please see the Schema features page, or visit the Basestar Schema docs.

Read on to discover the features provided by the Depot / Basestar YAML format.