@google-cloud/kcmd 0.0.0-stage → 0.2.0

package/build/ts/kcmd/semantic/graph_ddl.d.ts

@@ -0,0 +1,44 @@
+import { AiContext, Entity, Field, Metric, SemanticModel, SqlDialect } from './ir';
+export interface GenerateResult {
+    ddl: string;
+    warnings: string[];
+}
+export interface MetricPlacementInput {
+    entityByName: ReadonlyMap<string, Entity>;
+    skipped: ReadonlySet<string>;
+    ancestorsUsed: ReadonlySet<string>;
+    renderedFieldSql(entity: Entity, field: Field): {
+        sql: string;
+    } | {
+        reads: string;
+    };
+    localSql(entity: Entity, sql: string): {
+        sql: string;
+    } | {
+        reads: string;
+    };
+}
+export interface GraphEngine {
+    name: string;
+    table(dataSource: string, warnings: string[], context: string): string;
+    graphName(model: SemanticModel): string;
+    placeMetrics(metrics: Metric[], input: MetricPlacementInput, warnings: string[]): Map<string, string[]>;
+    elementOptions(description: string | undefined, ai: AiContext | undefined): string | undefined;
+    fieldOptions(field: Field): string | undefined;
+    dialect: SqlDialect;
+    fieldExpression(field: Field): string | undefined;
+}
+/**
+ * Generates the property-graph DDL for a semantic model on one engine.
+ *
+ * The generated statement references the entities' existing base tables; it
+ * does not create them. Returns the DDL plus any warnings collected while
+ * mapping the IR (e.g. metrics that could not be placed on a single table).
+ *
+ * Throws when the model yields no valid node table -- it declares no entities,
+ * or every entity lacks a KEY -- since a property graph with an empty NODE
+ * TABLES block is invalid DDL that the engine would reject.
+ */
+export declare function generateGraphDdl(model: SemanticModel, engine: GraphEngine): GenerateResult;
+export declare function nodeKey(entity: Pick<Entity, 'keys' | 'uniqueKeys'>): string[];
+export declare function physicalColumn(column: string): string;