Rename Database Schema

Renames a database schema (collection).

A schema defines a collection's fields, types, and validation. Schemas support drafts, versions, and publishing. Renames the database schema.

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.renameDatabaseSchema({
  id: 'sch_4kX9mQvR2tYw7ZbC1dFgHj',
  title: 'Orders summary',
  renameUniqueName: true,
});

.NET

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

using var client = new NorbixClient();

var result = await client.Database.RenameDatabaseSchemaAsync(new RenameDatabaseSchemaRequest
{
    Id = "sch_4kX9mQvR2tYw7ZbC1dFgHj",
    Title = "Orders summary",
    RenameUniqueName = true,
});

Python

from norbix_python import NorbixHub

norbix = NorbixHub()

result = norbix.database.rename_database_schema(
    id="sch_4kX9mQvR2tYw7ZbC1dFgHj",
    title="Orders summary",
    renameUniqueName=True,
)

Go

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

var result map[string]any
err := c.Hub.Database.RenameDatabaseSchema(ctx, "sch_4kX9mQvR2tYw7ZbC1dFgHj", map[string]any{
	"title": "Orders summary",
	"renameUniqueName": true,
}, &result)

Dart / Flutter

import 'package:norbix/norbix_hub.dart';

final hub = NorbixHub();

final result = await hub.database.renameDatabaseSchema(id: 'sch_4kX9mQvR2tYw7ZbC1dFgHj', body: {
  'title': 'Orders summary',
  'renameUniqueName': true,
});

Swift

import NorbixSwift

let client = Norbix()

let result = try await client.hub.database.renameDatabaseSchema([
    "id": "sch_4kX9mQvR2tYw7ZbC1dFgHj",
    "title": "Orders summary",
    "renameUniqueName": true,
])

Kotlin

import dev.norbix.sdk.hub.NorbixHub

val hub = NorbixHub()

val result = hub.database.renameDatabaseSchema(mapOf(
    "id" to "sch_4kX9mQvR2tYw7ZbC1dFgHj",
    "title" to "Orders summary",
    "renameUniqueName" to true,
))

CLI

norbix hub db schema rename sch_4kX9mQvR2tYw7ZbC1dFgHj --title 'Orders summary' --renameUniqueName true

In the dashboard

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

API reference

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