Module ksqldb_confluent.types.array_sql_type

Expand source code
# Copyright 2022 Confluent 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.
#
# Refer to LICENSE for more information.

from dataclasses import dataclass

from ksqldb_confluent.types.sql_type import SqlType
from ksqldb_confluent.types.sql_type_enum import SqlTypeEnum


@dataclass
class ArraySqlType(SqlType):
    """
    A sql type representing an array, which contains items of a given type.
    Attributes:
        item_type (SqlType): the SqlType of the contained items.
    """
    item_type: SqlType

    def get_sql_type_enum(self) -> SqlTypeEnum:
        """
        SqlType.ARRAY as this is an array

        Returns:
            SqlTypeEnum: SqlType.ARRAY
        """
        return SqlTypeEnum.ARRAY

Classes

class ArraySqlType (item_type: SqlType)

A sql type representing an array, which contains items of a given type.

Attributes

item_type : SqlType
the SqlType of the contained items.
Expand source code
@dataclass
class ArraySqlType(SqlType):
    """
    A sql type representing an array, which contains items of a given type.
    Attributes:
        item_type (SqlType): the SqlType of the contained items.
    """
    item_type: SqlType

    def get_sql_type_enum(self) -> SqlTypeEnum:
        """
        SqlType.ARRAY as this is an array

        Returns:
            SqlTypeEnum: SqlType.ARRAY
        """
        return SqlTypeEnum.ARRAY

Ancestors

Class variables

var item_typeSqlType

Methods

def get_sql_type_enum(self) ‑> SqlTypeEnum

SqlType.ARRAY as this is an array

Returns

SqlTypeEnum
SqlType.ARRAY
Expand source code
def get_sql_type_enum(self) -> SqlTypeEnum:
    """
    SqlType.ARRAY as this is an array

    Returns:
        SqlTypeEnum: SqlType.ARRAY
    """
    return SqlTypeEnum.ARRAY