StatementSummary

class oci.nosql.models.StatementSummary(**kwargs)

Bases: object

Information derived from parsing a NoSQL SQL statement.

Attributes:

OPERATION_ALTER_TABLE

A constant which can be used with the operation property of a StatementSummary.

OPERATION_CREATE_INDEX

A constant which can be used with the operation property of a StatementSummary.

OPERATION_CREATE_TABLE

A constant which can be used with the operation property of a StatementSummary.

OPERATION_DELETE

A constant which can be used with the operation property of a StatementSummary.

OPERATION_DROP_INDEX

A constant which can be used with the operation property of a StatementSummary.

OPERATION_DROP_TABLE

A constant which can be used with the operation property of a StatementSummary.

OPERATION_INSERT

A constant which can be used with the operation property of a StatementSummary.

OPERATION_SELECT

A constant which can be used with the operation property of a StatementSummary.

OPERATION_UPDATE

A constant which can be used with the operation property of a StatementSummary.

index_name

Gets the index_name of this StatementSummary.

is_if_exists

Gets the is_if_exists of this StatementSummary.

is_if_not_exists

Gets the is_if_not_exists of this StatementSummary.

operation

Gets the operation of this StatementSummary.

syntax_error

Gets the syntax_error of this StatementSummary.

table_name

Gets the table_name of this StatementSummary.

Methods:

__init__(**kwargs)

Initializes a new StatementSummary object with values from keyword arguments.

OPERATION_ALTER_TABLE = 'ALTER_TABLE'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “ALTER_TABLE”

OPERATION_CREATE_INDEX = 'CREATE_INDEX'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “CREATE_INDEX”

OPERATION_CREATE_TABLE = 'CREATE_TABLE'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “CREATE_TABLE”

OPERATION_DELETE = 'DELETE'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “DELETE”

OPERATION_DROP_INDEX = 'DROP_INDEX'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “DROP_INDEX”

OPERATION_DROP_TABLE = 'DROP_TABLE'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “DROP_TABLE”

OPERATION_INSERT = 'INSERT'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “INSERT”

OPERATION_SELECT = 'SELECT'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “SELECT”

OPERATION_UPDATE = 'UPDATE'

A constant which can be used with the operation property of a StatementSummary. This constant has a value of “UPDATE”

__init__(**kwargs)

Initializes a new StatementSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • operation (str) – The value to assign to the operation property of this StatementSummary. Allowed values for this property are: “CREATE_TABLE”, “ALTER_TABLE”, “DROP_TABLE”, “CREATE_INDEX”, “DROP_INDEX”, “SELECT”, “UPDATE”, “INSERT”, “DELETE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • table_name (str) – The value to assign to the table_name property of this StatementSummary.

  • index_name (str) – The value to assign to the index_name property of this StatementSummary.

  • is_if_exists (bool) – The value to assign to the is_if_exists property of this StatementSummary.

  • is_if_not_exists (bool) – The value to assign to the is_if_not_exists property of this StatementSummary.

  • syntax_error (str) – The value to assign to the syntax_error property of this StatementSummary.

property index_name

Gets the index_name of this StatementSummary. The index name from the SQL statement, if present.

Returns

The index_name of this StatementSummary.

Return type

str

property is_if_exists

Gets the is_if_exists of this StatementSummary. True if the statement includes “IF EXISTS.”

Returns

The is_if_exists of this StatementSummary.

Return type

bool

property is_if_not_exists

Gets the is_if_not_exists of this StatementSummary. True if the statement includes “IF NOT EXISTS.”

Returns

The is_if_not_exists of this StatementSummary.

Return type

bool

property operation

Gets the operation of this StatementSummary. The operation represented in the statement, e.g. CREATE_TABLE.

Allowed values for this property are: “CREATE_TABLE”, “ALTER_TABLE”, “DROP_TABLE”, “CREATE_INDEX”, “DROP_INDEX”, “SELECT”, “UPDATE”, “INSERT”, “DELETE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The operation of this StatementSummary.

Return type

str

property syntax_error

Gets the syntax_error of this StatementSummary. If present, indicates a syntax error in the statement.

Returns

The syntax_error of this StatementSummary.

Return type

str

property table_name

Gets the table_name of this StatementSummary. The table name from the SQL statement.

Returns

The table_name of this StatementSummary.

Return type

str