Module astrapy.data.utils.table_types

Expand source code 
# Copyright DataStax, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations

from astrapy.utils.str_enum import StrEnum


class ColumnType(StrEnum):
    """
    Enum to describe the scalar column types for Tables.

    A 'scalar' type is a non-composite type: that means, no sets, lists, maps
    and other non-primitive data types.
    """

    ASCII = "ascii"
    BIGINT = "bigint"
    BLOB = "blob"
    BOOLEAN = "boolean"
    COUNTER = "counter"
    DATE = "date"
    DECIMAL = "decimal"
    DOUBLE = "double"
    DURATION = "duration"
    FLOAT = "float"
    INET = "inet"
    INT = "int"
    SMALLINT = "smallint"
    TEXT = "text"
    TIME = "time"
    TIMESTAMP = "timestamp"
    TIMEUUID = "timeuuid"
    TINYINT = "tinyint"
    UUID = "uuid"
    VARINT = "varint"


class TableValuedColumnType(StrEnum):
    """
    An enum to describe the types of column with "values".
    """

    LIST = "list"
    SET = "set"


class TableKeyValuedColumnType(StrEnum):
    """
    An enum to describe the types of column with "keys and values".
    """

    MAP = "map"


class TableVectorColumnType(StrEnum):
    """
    An enum to describe the types of 'vector-like' column.
    """

    VECTOR = "vector"


class TableUDTColumnType(StrEnum):
    """
    An enum to describe the types of 'user-defined-type' (UDT) column.
    """

    USERDEFINED = "userDefined"


class TableUnsupportedColumnType(StrEnum):
    """
    An enum to describe the types of column falling into the 'unsupported' group
    (read/describe path).
    """

    UNSUPPORTED = "UNSUPPORTED"


class TablePassthroughColumnType(StrEnum):
    """
    An enum to describe the types for 'passthrough' columns (read/describe path).
    """

    PASSTHROUGH = "PASSTHROUGH"

Classes

class ColumnType (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enum to describe the scalar column types for Tables.

A 'scalar' type is a non-composite type: that means, no sets, lists, maps and other non-primitive data types.

Expand source code 
class ColumnType(StrEnum):
    """
    Enum to describe the scalar column types for Tables.

    A 'scalar' type is a non-composite type: that means, no sets, lists, maps
    and other non-primitive data types.
    """

    ASCII = "ascii"
    BIGINT = "bigint"
    BLOB = "blob"
    BOOLEAN = "boolean"
    COUNTER = "counter"
    DATE = "date"
    DECIMAL = "decimal"
    DOUBLE = "double"
    DURATION = "duration"
    FLOAT = "float"
    INET = "inet"
    INT = "int"
    SMALLINT = "smallint"
    TEXT = "text"
    TIME = "time"
    TIMESTAMP = "timestamp"
    TIMEUUID = "timeuuid"
    TINYINT = "tinyint"
    UUID = "uuid"
    VARINT = "varint"

Ancestors

Class variables

var ASCII
var BIGINT
var BLOB
var BOOLEAN
var COUNTER
var DATE
var DECIMAL
var DOUBLE
var DURATION
var FLOAT
var INET
var INT
var SMALLINT
var TEXT
var TIME
var TIMESTAMP
var TIMEUUID
var TINYINT
var UUID
var VARINT

Inherited members

class TableKeyValuedColumnType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enum to describe the types of column with "keys and values".

Expand source code 
class TableKeyValuedColumnType(StrEnum):
    """
    An enum to describe the types of column with "keys and values".
    """

    MAP = "map"

Ancestors

Class variables

var MAP

Inherited members

class TablePassthroughColumnType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enum to describe the types for 'passthrough' columns (read/describe path).

Expand source code 
class TablePassthroughColumnType(StrEnum):
    """
    An enum to describe the types for 'passthrough' columns (read/describe path).
    """

    PASSTHROUGH = "PASSTHROUGH"

Ancestors

Class variables

var PASSTHROUGH

Inherited members

class TableUDTColumnType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enum to describe the types of 'user-defined-type' (UDT) column.

Expand source code 
class TableUDTColumnType(StrEnum):
    """
    An enum to describe the types of 'user-defined-type' (UDT) column.
    """

    USERDEFINED = "userDefined"

Ancestors

Class variables

var USERDEFINED

Inherited members

class TableUnsupportedColumnType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enum to describe the types of column falling into the 'unsupported' group (read/describe path).

Expand source code 
class TableUnsupportedColumnType(StrEnum):
    """
    An enum to describe the types of column falling into the 'unsupported' group
    (read/describe path).
    """

    UNSUPPORTED = "UNSUPPORTED"

Ancestors

Class variables

var UNSUPPORTED

Inherited members

class TableValuedColumnType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enum to describe the types of column with "values".

Expand source code 
class TableValuedColumnType(StrEnum):
    """
    An enum to describe the types of column with "values".
    """

    LIST = "list"
    SET = "set"

Ancestors

Class variables

var LIST
var SET

Inherited members

class TableVectorColumnType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enum to describe the types of 'vector-like' column.

Expand source code 
class TableVectorColumnType(StrEnum):
    """
    An enum to describe the types of 'vector-like' column.
    """

    VECTOR = "vector"

Ancestors

Class variables

var VECTOR

Inherited members