CREATE EDGE TABLE

Enterprise command reference.

Command Snapshot

Field	Value
Category	Platform Extensions
Mutates Data	Yes/Depends
Scope	Cluster / Object
Privilege Model	Requires administrative or feature-specific governance/cluster privileges.

Purpose

Defines, changes, or removes schema and metadata objects.

Syntax

CREATE EDGE TABLE [IF NOT EXISTS] schema.table
FOR GRAPH graph_name
SOURCE KEY source_key_column
TARGET KEY target_key_column
[WITH (...)]

Operational Notes

• Use schema-qualified identifiers in automation and automation pipelines.
• Validate behavior in staging for cluster-impacting or governance-impacting changes.
• Confirm runtime effects through system tables and metrics before and after execution.

When to Use

• Use for graph, memory, governance, and licensing lifecycle management.
• Use when feature-specific metadata and policy controls are required.

When Not to Use

• Avoid enabling strict enforcement modes before validation and staged verification.

Common Errors and Troubleshooting

Symptom	Likely Cause	Action
Permission denied / unauthorized	Missing privilege on object or cluster scope	Re-run with required grants or elevated admin role.
Analysis/parse error	Syntax variant or object shape mismatch	Compare with canonical syntax and object definition.
Runtime failure under load	Resource limits, breaker pressure, or node state transitions	Check sys.jobs, sys.operations, sys.checks, and retry after mitigation.

Cross-References

• SQL Command Catalog
• SQL Commands Index
• SQL Reference Overview

Detailed Reference

Registers a relational table as an edge table for a named graph.

SQL Statement

CREATE EDGE TABLE [IF NOT EXISTS] schema.table
FOR GRAPH graph_name
SOURCE KEY source_key_column
TARGET KEY target_key_column
[WITH (...)]

Parameters

• schema.table: Existing table that stores edge rows.
• graph_name: Existing graph namespace.
• source_key_column: Source vertex reference.
• target_key_column: Target vertex reference.
• WITH (...): Optional registration properties.

Privileges

Requires DDL privilege on graph metadata and table metadata.

Example

CREATE TABLE doc.follows (
  src_id TEXT,
  dst_id TEXT,
  event_ts TIMESTAMPTZ,
  weight DOUBLE PRECISION,
  PRIMARY KEY (src_id, dst_id)
);

CREATE EDGE TABLE doc.follows FOR GRAPH social SOURCE KEY src_id TARGET KEY dst_id;

Notes

• Keep source/target key types aligned with vertex key type.
• Define relational constraints for data quality; graph registration does not enforce foreign keys.

Related

• CREATE GRAPH
• CREATE VERTEX TABLE