Schema Management

The GQLDB Node.js driver provides convenience methods for managing labels, properties, constraints, indexes, and fulltext indexes. These methods require a graph to be selected via useGraph() or a QueryConfig with graphName.

Label Methods

Listing Labels

TypeScript
await client.useGraph('myGraph');

// All labels
const labels = await client.showLabels();
for (const label of labels) {
  console.log(`${label.labels} (${label.type})`);
}

// Node labels only
const nodeLabels = await client.showNodeLabels();

// Edge labels only
const edgeLabels = await client.showEdgeLabels();

Listing Types (CLOSED Graph)

TypeScript
const nodeTypes = await client.showNodeTypes();
for (const nt of nodeTypes) {
  const props = nt.properties.map(p => p.name).join(', ');
  console.log(`${nt.name}: ${props}`);
}

Creating Labels

TypeScript
import { DBType } from '@ultipa-graph/ultipa-driver';

// Create a node label with properties
await client.createNodeLabel('Person', [
  { name: 'name', type: 'STRING' },
  { name: 'age', type: 'INT64' },
]);

// Create an edge label
await client.createEdgeLabel('KNOWS', [
  { name: 'since', type: 'INT64' },
]);

// Idempotent create — returns true if created, false if already existed
const created = await client.createLabelIfNotExist(DBType.NODE, 'Person', [
  { name: 'name', type: 'STRING' },
]);

Renaming / Dropping Labels

TypeScript
await client.alterNodeLabel('OldName', 'NewName');
await client.dropNodeLabel('Person');
await client.dropEdgeLabel('KNOWS', 'LIKES');

Property Methods

Managing Properties

TypeScript
// Show
const props = await client.showNodeProperty('Person');
for (const p of props) {
  console.log(`  ${p.name}: ${p.type}`);
}

// Add
await client.createNodeProperty('Person', [
  { name: 'email', type: 'STRING' },
]);

// Drop
await client.dropNodeProperty('Person', 'email');

Constraint Methods

Managing Constraints

TypeScript
import { DBType } from '@ultipa-graph/ultipa-driver';

await client.createNotNullConstraint(DBType.NODE, 'Person', 'name');
await client.createUniqueConstraint(DBType.NODE, 'Person', 'email');
await client.dropNotNullConstraint(DBType.NODE, 'Person', 'name');
await client.dropUniqueConstraint(DBType.NODE, 'Person', 'email');

Index Methods

Managing Indexes

TypeScript
// Show
const indexes = await client.showIndex();
for (const idx of indexes) {
  console.log(`${idx.indexName} on ${idx.label}.${idx.property} (${idx.status})`);
}

// Create
await client.createNodeIndex('idx_name', 'Person', [{ name: 'name' }]);

// With prefix length
await client.createNodeIndex('idx_prefix', 'Person', [{ name: 'name', prefixLength: 10 }]);

// Drop
await client.dropNodeIndex('idx_name');

Fulltext Index Methods

Managing Fulltext Indexes

TypeScript
// Show
const fts = await client.showFulltext();
for (const ft of fts) {
  console.log(`${ft.indexName} on ${ft.schemaName} (${ft.status})`);
}

// Create
await client.createNodeFulltext('ft_name', 'Person', ['name']);

// Drop
await client.dropNodeFulltext('ft_name');

Per-call Configuration

All methods accept an optional QueryConfig for per-call graph targeting:

TypeScript
const labels = await client.showNodeLabels({ graphName: 'graphA' });

Special Character Handling

Label and property names with special characters (spaces, hyphens, dots) are automatically wrapped in backticks by the SDK.

NOTE

Note: Graph names, index names, and fulltext index names do not support special characters.