For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Database Schema Draft

Gets the current draft of a database schema.

A schema defines a collection's fields, types, and validation. Schemas support drafts, versions, and publishing. This method returns a single database schema draft by id.

This method is on the Hub surface (norbix.hub.database) β€” call it from admin tooling or IaC.

These examples assume the SDK is installed and your credentials are set as environment variables β€” each client reads them automatically, so the constructors below take no arguments. See Install a Norbix SDK.

import { Norbix } from '@norbix.ai/ts';
const norbix = new Norbix();

const result = await norbix.hub.database.getDatabaseSchemaDraft({
  id: 'sch_4kX9mQvR2tYw7ZbC1dFgHj',
});
using Norbix.Sdk;
using Norbix.Sdk.Types.Hub;

using var client = new NorbixClient();

var result = await client.Database.GetDatabaseSchemaDraftAsync(new GetDatabaseSchemaDraft
{
    Id = "sch_4kX9mQvR2tYw7ZbC1dFgHj",
});
from norbix_python import NorbixHub

norbix = NorbixHub()

result = norbix.database.get_database_schema_draft(
    id="sch_4kX9mQvR2tYw7ZbC1dFgHj",
)

In the dashboard

Manage this visually in Norbix Cloud β€” see Database β†’ Schemas.

API reference

Full request and response for this endpoint: Get Database Schema Draft.

Last updated