Save Database Schema

save Database Schema.

A schema defines a collection's fields, types, and validation. Schemas support drafts, versions, and publishing. This method creates the database schema and returns its 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.

JavaScript / TypeScript

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

const result = await norbix.hub.database.saveDatabaseSchema({
  schemaName: 'orders',
  viewId: 'view_4kX9mQvR2tYw7ZbC1dFgHj',
  dataSchema: '{"type":"object"}',
  visualSchema: '{}',
});

.NET

using Norbix.Sdk;
using Norbix.Sdk.Types.Hub;

using var client = new NorbixClient();

var result = await client.Database.SaveDatabaseSchemaAsync(new SaveDatabaseSchemaRequest
{
    SchemaName = "orders",
    ViewId = "view_4kX9mQvR2tYw7ZbC1dFgHj",
    DataSchema = "{\"type\":\"object\"}",
    VisualSchema = "{}",
});

Python

from norbix_python import NorbixHub

norbix = NorbixHub()

result = norbix.database.save_database_schema(
    schemaName="orders",
    viewId="view_4kX9mQvR2tYw7ZbC1dFgHj",
    dataSchema="{\"type\":\"object\"}",
    visualSchema="{}",
)

Go

c, _ := norbix.New(norbix.Options{})
ctx := context.Background()

var result map[string]any
err := c.Hub.Database.SaveDatabaseSchema(ctx, map[string]any{
	"schemaName": "orders",
	"viewId": "view_4kX9mQvR2tYw7ZbC1dFgHj",
	"dataSchema": "{\"type\":\"object\"}",
	"visualSchema": "{}",
}, &result)

Dart / Flutter

import 'package:norbix/norbix_hub.dart';

final hub = NorbixHub();

final result = await hub.database.saveDatabaseSchema(body: {
  'schemaName': 'orders',
  'viewId': 'view_4kX9mQvR2tYw7ZbC1dFgHj',
  'dataSchema': '{"type":"object"}',
  'visualSchema': '{}',
});

Swift

import NorbixSwift

let client = Norbix()

let result = try await client.hub.database.saveDatabaseSchema([
    "schemaName": "orders",
    "viewId": "view_4kX9mQvR2tYw7ZbC1dFgHj",
    "dataSchema": "{\"type\":\"object\"}",
    "visualSchema": "{}",
])

Kotlin

import dev.norbix.sdk.hub.NorbixHub

val hub = NorbixHub()

val result = hub.database.saveDatabaseSchema(mapOf(
    "schemaName" to "orders",
    "viewId" to "view_4kX9mQvR2tYw7ZbC1dFgHj",
    "dataSchema" to "{\"type\":\"object\"}",
    "visualSchema" to "{}",
))

CLI

norbix hub db schema save --schemaName orders --viewId view_4kX9mQvR2tYw7ZbC1dFgHj --dataSchema '{"type":"object"}' --visualSchema '{}'

In the dashboard

Manage this visually in Norbix Cloud — see Database → Schemas.

API reference

Full request and response for this endpoint: Save Database Schema.