File-src-minisql-sql-ast-ml-1617141018.md

src/minisql/sql/ast.ml

Home · Files

Provides minisql sql ast facilities for this project.

Package: minisql.sql.ast

Reachable from entry: yes

Declarations

ALTER_TABLE_ADD_COLUMN

const ALTER_TABLE_ADD_COLUMN = 1

Defines the alter table add column constant used by the minisql sql ast module.

View source

ALTER_TABLE_ADD_CONSTRAINT

const ALTER_TABLE_ADD_CONSTRAINT = 4

Defines the alter table add constraint constant used by the minisql sql ast module.

View source

ALTER_TABLE_DROP_COLUMN

const ALTER_TABLE_DROP_COLUMN = 6

Defines the alter table drop column constant used by the minisql sql ast module.

View source

ALTER_TABLE_DROP_CONSTRAINT

const ALTER_TABLE_DROP_CONSTRAINT = 5

Defines the alter table drop constraint constant used by the minisql sql ast module.

View source

ALTER_TABLE_DROP_DEFAULT

const ALTER_TABLE_DROP_DEFAULT = 8

Defines the alter table drop default constant used by the minisql sql ast module.

View source

ALTER_TABLE_DROP_NOT_NULL

const ALTER_TABLE_DROP_NOT_NULL = 10

Defines the alter table drop not null constant used by the minisql sql ast module.

View source

ALTER_TABLE_RENAME_COLUMN

const ALTER_TABLE_RENAME_COLUMN = 2

Defines the alter table rename column constant used by the minisql sql ast module.

View source

ALTER_TABLE_RENAME_TABLE

const ALTER_TABLE_RENAME_TABLE = 3

Defines the alter table rename table constant used by the minisql sql ast module.

View source

ALTER_TABLE_SET_DEFAULT

const ALTER_TABLE_SET_DEFAULT = 7

Defines the alter table set default constant used by the minisql sql ast module.

View source

ALTER_TABLE_SET_NOT_NULL

const ALTER_TABLE_SET_NOT_NULL = 9

Defines the alter table set not null constant used by the minisql sql ast module.

View source

ALTER_USER_DISABLE

const ALTER_USER_DISABLE = 3

Defines the alter user disable constant used by the minisql sql ast module.

View source

ALTER_USER_ENABLE

const ALTER_USER_ENABLE = 2

Defines the alter user enable constant used by the minisql sql ast module.

View source

ALTER_USER_PASSWORD

const ALTER_USER_PASSWORD = 1

Defines the alter user password constant used by the minisql sql ast module.

View source

• minisql.sql.ast.AlterTableStatement — struct
• minisql.sql.ast.AlterTriggerStatement — struct
• minisql.sql.ast.AlterUserStatement — struct
• minisql.sql.ast.AnalyzeStatement — struct
• minisql.sql.ast.Assignment — struct
• minisql.sql.ast.BeginStatement — struct

betweenExpression

function betweenExpression(operand, lower, upper, negated)

Implements between expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
operand	dynamic	—	operand value consumed by this operation.
lower	dynamic	—	lower value consumed by this operation.
upper	dynamic	—	upper value consumed by this operation.
negated	dynamic	—	negated value consumed by this operation.

View source

• minisql.sql.ast.BetweenExpression — struct

binaryExpression

function binaryExpression(operator, left, right)

Implements binary expression for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
operator	dynamic	—	operator value consumed by this operation.
left	dynamic	—	left value consumed by this operation.
right	dynamic	—	right value consumed by this operation.

View source

• minisql.sql.ast.BinaryExpression — struct

booleanLiteral

function booleanLiteral(value)

Implements boolean literal for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

• minisql.sql.ast.CallStatement — struct

caseBranch

function caseBranch(condition, result)

Implements case branch for this module. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
condition	dynamic	—	condition value consumed by this operation.
result	dynamic	—	Result object populated or inspected by the operation.

View source

• minisql.sql.ast.CaseBranch — struct

caseExpression

function caseExpression(branches, elseExpression)

Implements case expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
branches	dynamic	—	branches value consumed by this operation.
elseExpression	dynamic	—	elseExpression value consumed by this operation.

View source

• minisql.sql.ast.CaseExpression — struct

castExpression

function castExpression(operand, targetType)

Casts expression using the supplied inputs. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
operand	dynamic	—	operand value consumed by this operation.
targetType	dynamic	—	targetType value consumed by this operation.

View source

• minisql.sql.ast.CastExpression — struct
• minisql.sql.ast.ColumnDefinition — struct

columnExpression

function columnExpression(qualifier, name)

Implements column expression for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
qualifier	dynamic	—	qualifier value consumed by this operation.
name	dynamic	—	Name of the affected item.

View source

• minisql.sql.ast.ColumnExpression — struct
• minisql.sql.ast.CommitStatement — struct
• minisql.sql.ast.CommonTableExpression — struct

componentName

function componentName()

Performs the componentName operation for the minisql sql ast module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

View source

CONFLICT_DO_NOTHING

const CONFLICT_DO_NOTHING = 1

Defines the conflict do nothing constant used by the minisql sql ast module.

View source

CONFLICT_DO_UPDATE

const CONFLICT_DO_UPDATE = 2

Defines the conflict do update constant used by the minisql sql ast module.

View source

CONFLICT_NONE

const CONFLICT_NONE = 0

Defines the conflict none constant used by the minisql sql ast module.

View source

CONSTRAINT_CHECK

const CONSTRAINT_CHECK = 3

Defines the constraint check constant used by the minisql sql ast module.

View source

CONSTRAINT_FOREIGN_KEY

const CONSTRAINT_FOREIGN_KEY = 4

Defines the constraint foreign key constant used by the minisql sql ast module.

View source

CONSTRAINT_PRIMARY_KEY

const CONSTRAINT_PRIMARY_KEY = 1

Defines the constraint primary key constant used by the minisql sql ast module.

View source

CONSTRAINT_UNIQUE

const CONSTRAINT_UNIQUE = 2

Defines the constraint unique constant used by the minisql sql ast module.

View source

containsTypedLiteral

function containsTypedLiteral(expression)

Reports whether an expression tree embeds an executor-created typed literal. These values intentionally format opaquely and therefore cannot participate in a value-sensitive physical-plan cache key.

Parameter	Type	Default	Description
expression	dynamic	—	expression value consumed by this operation.

View source

• minisql.sql.ast.CreateIndexStatement — struct
• minisql.sql.ast.CreatePrincipalStatement — struct
• minisql.sql.ast.CreateProcedureStatement — struct
• minisql.sql.ast.CreateSchemaStatement — struct
• minisql.sql.ast.CreateSequenceStatement — struct
• minisql.sql.ast.CreateTableStatement — struct
• minisql.sql.ast.CreateTriggerStatement — struct
• minisql.sql.ast.CreateViewStatement — struct

currentTimestampLiteral

function currentTimestampLiteral()

Implements current timestamp literal for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

View source

DCL_OBJECT_DATABASE

const DCL_OBJECT_DATABASE = 1

Defines the dcl object database constant used by the minisql sql ast module.

View source

DCL_OBJECT_TABLE

const DCL_OBJECT_TABLE = 2

Defines the dcl object table constant used by the minisql sql ast module.

View source

• minisql.sql.ast.DeallocateStatement — struct
• minisql.sql.ast.DeleteStatement — struct
• minisql.sql.ast.DescribeTableStatement — struct
• minisql.sql.ast.DropIndexStatement — struct
• minisql.sql.ast.DropPrincipalStatement — struct
• minisql.sql.ast.DropProcedureStatement — struct
• minisql.sql.ast.DropSchemaStatement — struct
• minisql.sql.ast.DropSequenceStatement — struct
• minisql.sql.ast.DropTableStatement — struct
• minisql.sql.ast.DropTriggerStatement — struct
• minisql.sql.ast.DropViewStatement — struct
• minisql.sql.ast.ExecutePreparedStatement — struct

existsExpression

function existsExpression(query)

Implements exists expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
query	dynamic	—	query value consumed by this operation.

View source

• minisql.sql.ast.ExistsExpression — struct
• minisql.sql.ast.ExplainStatement — struct

EXPR_BETWEEN

const EXPR_BETWEEN = 12

Defines the expr between constant used by the minisql sql ast module.

View source

EXPR_BINARY

const EXPR_BINARY = 5

Defines the expr binary constant used by the minisql sql ast module.

View source

EXPR_CASE

const EXPR_CASE = 9

Defines the expr case constant used by the minisql sql ast module.

View source

EXPR_CAST

const EXPR_CAST = 10

Defines the expr cast constant used by the minisql sql ast module.

View source

EXPR_COLUMN

const EXPR_COLUMN = 2

Defines the expr column constant used by the minisql sql ast module.

View source

EXPR_EXISTS

const EXPR_EXISTS = 16

Defines the expr exists constant used by the minisql sql ast module.

View source

EXPR_FUNCTION

const EXPR_FUNCTION = 7

Defines the expr function constant used by the minisql sql ast module.

View source

EXPR_IN

const EXPR_IN = 11

Defines the expr in constant used by the minisql sql ast module.

View source

EXPR_IN_SUBQUERY

const EXPR_IN_SUBQUERY = 17

Defines the expr in subquery constant used by the minisql sql ast module.

View source

EXPR_IS_NULL

const EXPR_IS_NULL = 6

Defines the expr is null constant used by the minisql sql ast module.

View source

EXPR_LITERAL

const EXPR_LITERAL = 1

Syntax tree for the MiniSQL SQL front end. The AST contains no catalog

View source

EXPR_PARAMETER

const EXPR_PARAMETER = 8

Defines the expr parameter constant used by the minisql sql ast module.

View source

EXPR_STAR

const EXPR_STAR = 3

Defines the expr star constant used by the minisql sql ast module.

View source

EXPR_SUBQUERY

const EXPR_SUBQUERY = 15

Defines the expr subquery constant used by the minisql sql ast module.

View source

EXPR_TRUTH_TEST

const EXPR_TRUTH_TEST = 13

Defines the expr truth test constant used by the minisql sql ast module.

View source

EXPR_TYPED_LITERAL

const EXPR_TYPED_LITERAL = 14

Defines the expr typed literal constant used by the minisql sql ast module.

View source

EXPR_UNARY

const EXPR_UNARY = 4

Defines the expr unary constant used by the minisql sql ast module.

View source

EXPR_WINDOW

const EXPR_WINDOW = 18

Defines the expr window constant used by the minisql sql ast module.

View source

expressionKind

function expressionKind(value)

Implements expression kind for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

floatLiteral

function floatLiteral(value)

Implements float literal for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

formatExpression

function formatExpression(expression)

Formats expression using the supplied inputs. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
expression	dynamic	—	expression value consumed by this operation.

View source

formatFunction

function formatFunction(expression)

Formats function using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
expression	dynamic	—	expression value consumed by this operation.

View source

formatOrderItem

function formatOrderItem(item)

Formats order item using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
item	dynamic	—	item value consumed by this operation.

View source

formatSelect

function formatSelect(statement)

Formats select using the supplied inputs. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
statement	dynamic	—	statement value consumed by this operation.

View source

formatSelectItem

function formatSelectItem(item)

Formats select item using the supplied inputs. Requires arguments that satisfy the validation performed below. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
item	dynamic	—	item value consumed by this operation.

View source

formatStatement

function formatStatement(statement)

Formats statement using the supplied inputs. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
statement	dynamic	—	statement value consumed by this operation.

View source

formatTypeName

function formatTypeName(value)

Formats type name using the supplied inputs. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

functionExpression

function functionExpression(name, arguments, distinct)

Implements function expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
name	dynamic	—	Name of the affected item.
arguments	dynamic	—	arguments value consumed by this operation.
distinct	dynamic	—	distinct value consumed by this operation.

View source

• minisql.sql.ast.FunctionExpression — struct
• minisql.sql.ast.GrantPrivilegeStatement — struct
• minisql.sql.ast.GrantRoleStatement — struct

identifier

function identifier(name, quoted)

Implements identifier for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
name	dynamic	—	Name of the affected item.
quoted	dynamic	—	quoted value consumed by this operation.

View source

• minisql.sql.ast.Identifier — struct

inExpression

function inExpression(operand, candidates, negated)

Implements in expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
operand	dynamic	—	operand value consumed by this operation.
candidates	dynamic	—	candidates value consumed by this operation.
negated	dynamic	—	negated value consumed by this operation.

View source

• minisql.sql.ast.InExpression — struct
• minisql.sql.ast.InsertStatement — struct

inSubqueryExpression

function inSubqueryExpression(operand, query, negated)

Implements in subquery expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
operand	dynamic	—	operand value consumed by this operation.
query	dynamic	—	query value consumed by this operation.
negated	dynamic	—	negated value consumed by this operation.

View source

• minisql.sql.ast.InSubqueryExpression — struct

integerLiteral

function integerLiteral(value)

Implements integer literal for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isAlterTableStatement

function isAlterTableStatement(value)

Returns whether the supplied value satisfies the alter table statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isAlterTriggerStatement

function isAlterTriggerStatement(value)

Returns whether the supplied statement changes trigger activation.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isAlterUserStatement

function isAlterUserStatement(value)

Returns whether the supplied value satisfies the alter user statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isAnalyzeStatement

function isAnalyzeStatement(value)

Returns whether the supplied value satisfies the analyze statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isBeginStatement

function isBeginStatement(value)

Returns whether the supplied value satisfies the begin statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isBetweenExpression

function isBetweenExpression(value)

Returns whether the supplied value satisfies the between expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isBinaryExpression

function isBinaryExpression(value)

Returns whether the supplied value satisfies the binary expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCallStatement

function isCallStatement(value)

Returns whether the supplied statement invokes a stored procedure.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCaseExpression

function isCaseExpression(value)

Returns whether the supplied value satisfies the case expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCastExpression

function isCastExpression(value)

Returns whether the supplied value satisfies the cast expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isColumnExpression

function isColumnExpression(value)

Returns whether the supplied value satisfies the column expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCommitStatement

function isCommitStatement(value)

Returns whether the supplied value satisfies the commit statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreateIndexStatement

function isCreateIndexStatement(value)

Returns whether the supplied value satisfies the create index statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreatePrincipalStatement

function isCreatePrincipalStatement(value)

Returns whether the supplied value satisfies the create principal statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreateProcedureStatement

function isCreateProcedureStatement(value)

Returns whether the supplied statement creates a stored procedure.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreateSchemaStatement

function isCreateSchemaStatement(value)

Returns whether the supplied statement creates a schema namespace.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreateSequenceStatement

function isCreateSequenceStatement(value)

Returns whether the supplied value satisfies the create sequence statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreateTableStatement

function isCreateTableStatement(value)

Returns whether the supplied value satisfies the create table statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreateTriggerStatement

function isCreateTriggerStatement(value)

Returns whether the supplied value satisfies the create trigger statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isCreateViewStatement

function isCreateViewStatement(value)

Returns whether the supplied value satisfies the create view statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDclStatement

function isDclStatement(value)

Returns whether the supplied value satisfies the dcl statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDeallocateStatement

function isDeallocateStatement(value)

Returns whether the supplied value satisfies the deallocate statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDeleteStatement

function isDeleteStatement(value)

Returns whether the supplied value satisfies the delete statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDescribeTableStatement

function isDescribeTableStatement(value)

Returns whether the supplied value satisfies the describe table statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropIndexStatement

function isDropIndexStatement(value)

Returns whether the supplied value is a DROP INDEX statement.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropPrincipalStatement

function isDropPrincipalStatement(value)

Returns whether the supplied value satisfies the drop principal statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropProcedureStatement

function isDropProcedureStatement(value)

Returns whether the supplied statement drops a stored procedure.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropSchemaStatement

function isDropSchemaStatement(value)

Returns whether the supplied statement drops a schema namespace.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropSequenceStatement

function isDropSequenceStatement(value)

Returns whether the supplied value satisfies the drop sequence statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropTableStatement

function isDropTableStatement(value)

Returns whether the supplied value satisfies the drop table statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropTriggerStatement

function isDropTriggerStatement(value)

Returns whether the supplied value satisfies the drop trigger statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isDropViewStatement

function isDropViewStatement(value)

Returns whether the supplied value satisfies the drop view statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isExecutePreparedStatement

function isExecutePreparedStatement(value)

Returns whether the supplied value satisfies the execute prepared statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isExistsExpression

function isExistsExpression(value)

Returns whether the supplied value satisfies the exists expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isExplainStatement

function isExplainStatement(value)

Returns whether the supplied value satisfies the explain statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isExpression

function isExpression(value)

Returns whether the supplied value satisfies the expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isFunctionExpression

function isFunctionExpression(value)

Returns whether the supplied value satisfies the function expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isGrantPrivilegeStatement

function isGrantPrivilegeStatement(value)

Returns whether the supplied value satisfies the grant privilege statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isGrantRoleStatement

function isGrantRoleStatement(value)

Returns whether the supplied value satisfies the grant role statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isImplemented

function isImplemented()

Returns whether implemented satisfies the condition required by the minisql sql ast module. Returns the computed value or operation status. Does not modify its inputs.

View source

isInExpression

function isInExpression(value)

Returns whether the supplied value satisfies the in expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isInsertStatement

function isInsertStatement(value)

Returns whether the supplied value satisfies the insert statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isInSubqueryExpression

function isInSubqueryExpression(value)

Returns whether the supplied value satisfies the in subquery expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isIsNullExpression

function isIsNullExpression(value)

Returns whether the supplied value satisfies the is null expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isLiteralExpression

function isLiteralExpression(value)

Returns whether the supplied value satisfies the literal expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isMergeStatement

function isMergeStatement(value)

Returns whether the supplied statement is a MERGE operation.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isMetadataStatement

function isMetadataStatement(value)

Returns whether the supplied value satisfies the metadata statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isNullExpression

function isNullExpression(operand, negated)

Returns whether the supplied value satisfies the null expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
operand	dynamic	—	operand value consumed by this operation.
negated	dynamic	—	negated value consumed by this operation.

View source

• minisql.sql.ast.IsNullExpression — struct

isParameterExpression

function isParameterExpression(value)

Returns whether the supplied value satisfies the parameter expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isPrepareStatement

function isPrepareStatement(value)

Returns whether the supplied value satisfies the prepare statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isReindexStatement

function isReindexStatement(value)

Returns whether the supplied value satisfies the reindex statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isReleaseSavepointStatement

function isReleaseSavepointStatement(value)

Returns whether the supplied value satisfies the release savepoint statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isRevokePrivilegeStatement

function isRevokePrivilegeStatement(value)

Returns whether the supplied value satisfies the revoke privilege statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isRevokeRoleStatement

function isRevokeRoleStatement(value)

Returns whether the supplied value satisfies the revoke role statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isRollbackStatement

function isRollbackStatement(value)

Returns whether the supplied value satisfies the rollback statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isRollbackToStatement

function isRollbackToStatement(value)

Returns whether the supplied value satisfies the rollback to statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isSavepointStatement

function isSavepointStatement(value)

Returns whether the supplied value satisfies the savepoint statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isSelectStatement

function isSelectStatement(value)

Returns whether the supplied value satisfies the select statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isShowIndexesStatement

function isShowIndexesStatement(value)

Returns whether the supplied value satisfies the show indexes statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isShowProcesslistStatement

function isShowProcesslistStatement(value)

Returns whether the value is a SHOW PROCESSLIST statement.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isShowStatusStatement

function isShowStatusStatement(value)

Returns whether the value is a SHOW STATUS statement.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isShowTablesStatement

function isShowTablesStatement(value)

Returns whether the supplied value satisfies the show tables statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isShutdownStatement

function isShutdownStatement(value)

Returns whether the value is a cooperative SHUTDOWN statement.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isStarExpression

function isStarExpression(value)

Returns whether the supplied value satisfies the star expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isStatement

function isStatement(value)

Returns whether the supplied value satisfies the statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isSubqueryExpression

function isSubqueryExpression(value)

Returns whether the supplied value satisfies the subquery expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isTruncateStatement

function isTruncateStatement(value)

Returns whether the supplied value satisfies the truncate statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isTruthTestExpression

function isTruthTestExpression(value)

Returns whether the supplied value satisfies the truth test expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isTypedLiteralExpression

function isTypedLiteralExpression(value)

Returns whether the supplied value satisfies the typed literal expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isTypeName

function isTypeName(value)

Returns whether the supplied value satisfies the type name condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isUnaryExpression

function isUnaryExpression(value)

Returns whether the supplied value satisfies the unary expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isUpdateStatement

function isUpdateStatement(value)

Returns whether the supplied value satisfies the update statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isVacuumStatement

function isVacuumStatement(value)

Returns whether the supplied value satisfies the vacuum statement condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

isWindowExpression

function isWindowExpression(value)

Returns whether the supplied value satisfies the window expression condition. Returns the computed value or operation status. Does not modify its inputs.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

JOIN_CROSS

const JOIN_CROSS = 3

Defines the join cross constant used by the minisql sql ast module.

View source

JOIN_FULL

const JOIN_FULL = 5

Defines the join full constant used by the minisql sql ast module.

View source

JOIN_INNER

const JOIN_INNER = 1

Defines the join inner constant used by the minisql sql ast module.

View source

JOIN_LEFT

const JOIN_LEFT = 2

Defines the join left constant used by the minisql sql ast module.

View source

JOIN_RIGHT

const JOIN_RIGHT = 4

Defines the join right constant used by the minisql sql ast module.

View source

• minisql.sql.ast.JoinClause — struct

LITERAL_BOOLEAN

const LITERAL_BOOLEAN = 1

Defines the literal boolean constant used by the minisql sql ast module.

View source

LITERAL_CURRENT_TIMESTAMP

const LITERAL_CURRENT_TIMESTAMP = 5

Defines the literal current timestamp constant used by the minisql sql ast module.

View source

LITERAL_FLOAT

const LITERAL_FLOAT = 3

Defines the literal float constant used by the minisql sql ast module.

View source

LITERAL_INTEGER

const LITERAL_INTEGER = 2

Defines the literal integer constant used by the minisql sql ast module.

View source

LITERAL_NULL

const LITERAL_NULL = 0

Defines the literal null constant used by the minisql sql ast module.

View source

LITERAL_STRING

const LITERAL_STRING = 4

Defines the literal string constant used by the minisql sql ast module.

View source

• minisql.sql.ast.LiteralExpression — struct
• minisql.sql.ast.MergeStatement — struct

nullLiteral

function nullLiteral()

Implements null literal for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

View source

• minisql.sql.ast.OrderItem — struct

parameterExpression

function parameterExpression(index)

Implements parameter expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
index	dynamic	—	Zero-based index of the affected item.

View source

• minisql.sql.ast.ParameterExpression — struct
• minisql.sql.ast.PrepareStatement — struct

PRINCIPAL_ROLE

const PRINCIPAL_ROLE = 2

Defines the principal role constant used by the minisql sql ast module.

View source

PRINCIPAL_USER

const PRINCIPAL_USER = 1

Defines the principal user constant used by the minisql sql ast module.

View source

• minisql.sql.ast.ProcedureParameter — struct

quoteString

function quoteString(value)

Implements quote string for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

• minisql.sql.ast.ReindexStatement — struct
• minisql.sql.ast.ReleaseSavepointStatement — struct
• minisql.sql.ast.RevokePrivilegeStatement — struct
• minisql.sql.ast.RevokeRoleStatement — struct
• minisql.sql.ast.RollbackStatement — struct
• minisql.sql.ast.RollbackToStatement — struct
• minisql.sql.ast.SavepointStatement — struct

selectContainsTypedLiteral

function selectContainsTypedLiteral(statement)

Reports whether any clause of a SELECT embeds a typed literal.

Parameter	Type	Default	Description
statement	dynamic	—	statement value consumed by this operation.

View source

• minisql.sql.ast.SelectItem — struct
• minisql.sql.ast.SelectStatement — struct

SET_EXCEPT

const SET_EXCEPT = 3

Defines the set except constant used by the minisql sql ast module.

View source

SET_INTERSECT

const SET_INTERSECT = 2

Defines the set intersect constant used by the minisql sql ast module.

View source

SET_UNION

const SET_UNION = 1

Defines the set union constant used by the minisql sql ast module.

View source

• minisql.sql.ast.SetOperation — struct
• minisql.sql.ast.ShowIndexesStatement — struct
• minisql.sql.ast.ShowProcesslistStatement — struct
• minisql.sql.ast.ShowStatusStatement — struct
• minisql.sql.ast.ShowTablesStatement — struct
• minisql.sql.ast.ShutdownStatement — struct

starExpression

function starExpression(qualifier)

Implements star expression for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
qualifier	dynamic	—	qualifier value consumed by this operation.

View source

• minisql.sql.ast.StarExpression — struct

stringLiteral

function stringLiteral(value)

Implements string literal for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

subqueryExpression

function subqueryExpression(query)

Implements subquery expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
query	dynamic	—	query value consumed by this operation.

View source

• minisql.sql.ast.SubqueryExpression — struct
• minisql.sql.ast.TableConstraint — struct

targetMilestone

function targetMilestone()

Performs the targetMilestone operation for the minisql sql ast module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

View source

• minisql.sql.ast.TruncateStatement — struct

truthTestExpression

function truthTestExpression(operand, expected, negated)

Implements truth test expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
operand	dynamic	—	operand value consumed by this operation.
expected	dynamic	—	expected value consumed by this operation.
negated	dynamic	—	negated value consumed by this operation.

View source

• minisql.sql.ast.TruthTestExpression — struct

typedLiteralExpression

function typedLiteralExpression(value)

Implements typed literal expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
value	dynamic	—	Value consumed or transformed by the operation.

View source

• minisql.sql.ast.TypedLiteralExpression — struct

typeName

function typeName(name, length, precision, scale)

Implements type name for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
name	dynamic	—	Name of the affected item.
length	dynamic	—	length value consumed by this operation.
precision	dynamic	—	precision value consumed by this operation.
scale	dynamic	—	scale value consumed by this operation.

View source

• minisql.sql.ast.TypeName — struct

unaryExpression

function unaryExpression(operator, operand)

Implements unary expression for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
operator	dynamic	—	operator value consumed by this operation.
operand	dynamic	—	operand value consumed by this operation.

View source

• minisql.sql.ast.UnaryExpression — struct
• minisql.sql.ast.UpdateStatement — struct
• minisql.sql.ast.VacuumStatement — struct

windowExpression

function windowExpression(name, arguments, partitionBy, orderBy)

Implements window expression for this module. Requires arguments that satisfy the validation performed below. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
name	dynamic	—	Name of the affected item.
arguments	dynamic	—	arguments value consumed by this operation.
partitionBy	dynamic	—	partitionBy value consumed by this operation.
orderBy	dynamic	—	orderBy value consumed by this operation.

View source

• minisql.sql.ast.WindowExpression — struct