gudusoft.gsqlparser.sqlenv.parser.sqlflow

Class SqlflowNameForm

Object

gudusoft.gsqlparser.sqlenv.parser.sqlflow.SqlflowNameForm

public final class SqlflowNameForm
extends Object

The nameForm declaration of the sqlflow servers metadata format (plain and sharded), for a reader that works on the parsed JSON tree itself.

A file declares once, at its root, how it writes object names: SQL_LEXICAL ("Amount", the default and what the sqlflow-ingester exporter emits) or CATALOG_STORED (Amount, the name the database catalog holds). Every reader of the format reads names as SQL text, so a CATALOG_STORED tree is rewritten here, once, into the SQL spelling of the same stored names. The spelling rule itself is TSQLEnv.toLexical(gudusoft.gsqlparser.EDbVendor, gudusoft.gsqlparser.sqlenv.ESQLDataObjectType, java.lang.String, gudusoft.gsqlparser.sqlenv.IdentifierInputForm); this class only knows which JSON key holds which kind of name.

SqlflowSQLEnv and SqlflowShardedSQLEnv apply the same rule name by name instead, because their public constructors receive a caller-owned map that must not be modified. See docs/refactor/identifier/README.md, "Catalog inputs and name output".

Method Summary

Modifier and Type	Method and Description
static IdentifierInputForm	declared(Map root) The form a servers file declares; SQL_LEXICAL when it declares none.
static void	shardToLexicalInPlace(EDbVendor vendor, Map shard, ESQLDataObjectType role, IdentifierInputForm manifestForm) Rewrite one catalog or schema shard of a sharded export, in place.
static IdentifierInputForm	toLexicalInPlace(EDbVendor defaultVendor, Map root) Rewrite a parsed servers file, in place, so that its names are SQL text.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

declared

public static IdentifierInputForm declared(Map root)

The form a servers file declares; SQL_LEXICAL when it declares none.

Throws:

TSQLEnv.InvalidNameFormException - for a misspelt value

toLexicalInPlace

public static IdentifierInputForm toLexicalInPlace(EDbVendor defaultVendor,
                                                   Map root)

Rewrite a parsed servers file, in place, so that its names are SQL text. Does nothing unless the file declares CATALOG_STORED. The declaration is then changed to SQL_LEXICAL, so a second call cannot encode the names twice.

Parameters:

defaultVendor - the dialect of a server that carries no dbVendor

Returns:

the form the file declared before the call

shardToLexicalInPlace

public static void shardToLexicalInPlace(EDbVendor vendor,
                                         Map shard,
                                         ESQLDataObjectType role,
                                         IdentifierInputForm manifestForm)

Rewrite one catalog or schema shard of a sharded export, in place. A shard carries no declaration of its own: the manifest's nameForm covers all of them.

Parameters:

role - what the shard's own name is (dotCatalog or dotSchema), or null to leave it alone