Schema Management

The GQLDB Go 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.

NOTE

Note: PropertyDef is re-exported by the root gqldb package, but DBType (DBTypeNode / DBTypeEdge) and IndexProperty are not — they live in the types subpackage. Import it alongside the root package:

Go
import (
    gqldb "github.com/ultipa/ultipa-go-driver/v6"
    "github.com/ultipa/ultipa-go-driver/v6/types"
)

Label Methods

Listing Labels

Go
client.UseGraph(ctx, "myGraph")

// All labels
labels, err := client.ShowLabels(ctx, nil)
for _, label := range labels {
    fmt.Printf("%v (%s)\n", label.Labels, label.Type)
}

// Node labels only
nodeLabels, err := client.ShowNodeLabels(ctx, nil)

// Edge labels only
edgeLabels, err := client.ShowEdgeLabels(ctx, nil)

Listing Types (CLOSED Graph)

Go
nodeTypes, err := client.ShowNodeTypes(ctx, nil)
for _, nt := range nodeTypes {
    fmt.Printf("%s: ", nt.Name)
    for _, p := range nt.Properties {
        fmt.Printf("%s(%s) ", p.Name, p.Type)
    }
    fmt.Println()
}

Creating Labels

Go
// Create a node label with properties
_, err := client.CreateNodeLabel(ctx, "Person", []gqldb.PropertyDef{
    {Name: "name", Type: gqldb.PropertyTypeString},
    {Name: "age", Type: gqldb.PropertyTypeInt64},
}, nil)

// Create an edge label
_, err = client.CreateEdgeLabel(ctx, "KNOWS", []gqldb.PropertyDef{
    {Name: "since", Type: gqldb.PropertyTypeInt64},
}, nil)

// Idempotent create
created, err := client.CreateLabelIfNotExist(ctx, types.DBTypeNode, "Person", props, nil)
// true = created, false = already existed

Renaming / Dropping Labels

Go
client.AlterNodeLabel(ctx, "OldName", "NewName", nil)
client.DropNodeLabel(ctx, "Person", nil)
client.DropEdgeLabel(ctx, nil, "KNOWS", "LIKES")

Property Methods

Managing Properties

Go
// Show
props, err := client.ShowNodeProperty(ctx, "Person", nil)

// Add
_, err = client.CreateNodeProperty(ctx, "Person", []gqldb.PropertyDef{
    {Name: "email", Type: gqldb.PropertyTypeString},
}, nil)

// Drop
_, err = client.DropNodeProperty(ctx, "Person", nil, "email")

Constraint Methods

Managing Constraints

Go
client.CreateNotNullConstraint(ctx, types.DBTypeNode, "Person", "name", nil)
client.CreateUniqueConstraint(ctx, types.DBTypeNode, "Person", nil, "email")
client.DropNotNullConstraint(ctx, types.DBTypeNode, "Person", "name", nil)
client.DropUniqueConstraint(ctx, types.DBTypeNode, "Person", nil, "email")

Index Methods

Managing Indexes

Go
// Show
indexes, err := client.ShowIndex(ctx, nil)

// Create
_, err = client.CreateNodeIndex(ctx, "idx_name", "Person",
    []types.IndexProperty{{Name: "name"}}, nil)

// With prefix length
_, err = client.CreateNodeIndex(ctx, "idx_prefix", "Person",
    []types.IndexProperty{{Name: "name", PrefixLength: 10}}, nil)

// Drop
_, err = client.DropNodeIndex(ctx, "idx_name", nil)

Fulltext Index Methods

Managing Fulltext Indexes

Go
// Show
fts, err := client.ShowFulltext(ctx, nil)

// Create
_, err = client.CreateNodeFulltext(ctx, "ft_name", "Person", []string{"name"}, nil)

// Drop
_, err = client.DropNodeFulltext(ctx, "ft_name", nil)

Per-call Configuration

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

Go
qc := &gqldb.QueryConfig{GraphName: "graphA"}
labels, err := client.ShowNodeLabels(ctx, qc)

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.