@google-cloud/kcmd 0.0.0-stage → 0.2.0

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

@@ -0,0 +1,72 @@
+import { SerializedFile } from './osi_converter';
+import { SourceDialects } from './source_dialect';
+/** Options controlling how a semantic model YAML document is imported. */
+export interface ImportSemanticModelOptions {
+    /**
+     * Target output flavor (`'ossie'` or `'google'`); defaults to input flavor.
+     */
+    flavor?: 'ossie' | 'google';
+    /**
+     * First-party GCP container resource name used to qualify bare table
+     * sources, or the name of a Knowledge Catalog entry group
+     * (`projects/<p>/locations/<l>/entryGroups/<g>`) whose table entries complete
+     * them by their fullyQualifiedName.
+     */
+    sourcePrefix?: string;
+    /**
+     * Lists every entry of an entry group, as `CatalogClient.listEntries` does.
+     * Required when `sourcePrefix` names an entry group.
+     */
+    listEntries?: EntryLister;
+    /**
+     * Reads the dialect of each Cloud SQL, Spanner and third-party table the
+     * files `texts` name, as `sourceDialects` does for push. Without it, the
+     * dialect of each such table is unknown.
+     */
+    readDialects?: (texts: string[]) => Promise<SourceDialects>;
+    /** When true, translates vendor or double-quoted ANSI SQL to `BIGQUERY`. */
+    transpile?: boolean;
+    /**
+     * When true, treats any third-party repair warning as a hard error, except
+     * completing a bare table source from `sourcePrefix`.
+     */
+    strict?: boolean;
+    /**
+     * Sibling `<model>.profile.<name>.yaml` files located beside the input file.
+     * A conversion to vanilla writes them into the model file, and a
+     * Google-flavor import of a Google-flavor model writes them beside it.
+     */
+    profileFiles?: SerializedFile[];
+    /**
+     * The input file's name. The warning that a JSON input was written as YAML
+     * names it, or `<model>.yaml` when it is unset. When set, in strict mode
+     * each message about the model's bindings names the input file or profile
+     * file that holds them.
+     */
+    fileName?: string;
+}
+/** Lists the entries of an entry group. */
+export type EntryLister = (project: string, location: string, entryGroup: string) => AsyncIterable<{
+    name: string;
+    fullyQualifiedName?: string;
+}>;
+/** Result of importing a semantic model YAML document. */
+export interface ImportSemanticModelResult {
+    /** True when `errors` is empty and `files` was produced. */
+    ok: boolean;
+    /**
+     * Generated output files (`<model>.yaml` and any
+     * `<model>.profile.<name>.yaml` files), or `[]` when `ok` is false.
+     */
+    files: SerializedFile[];
+    /** Non-fatal repair and translation diagnostics. */
+    warnings: string[];
+    /** Validation or strict-mode errors that prevented file output. */
+    errors: string[];
+}
+/**
+ * Repairs, converts, optionally transpiles, and validates a semantic model YAML
+ * document, returning the normalized output file(s) along with any warnings or
+ * errors.
+ */
+export declare function importSemanticModelYaml(rawYaml: string, opts?: ImportSemanticModelOptions): Promise<ImportSemanticModelResult>;