Module ksqldb_confluent.types.struct_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 typing import List

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


@dataclass
class Field:
    """
    Represents a field of a struct.

    Attributes:
        sql_type (SqlType): The type of the field.
        name (str): The name of the field.
    """
    sql_type: SqlType
    name: str


@dataclass
class StructSqlType(SqlType):
    """
    Represents a struct, containing zero or more fields.

    Attributes:
        fields (List[Field]): The fields of this struct.
    """
    fields: List[Field]

    def get_sql_type_enum(self) -> SqlTypeEnum:
        """
        SqlType.STRUCT as this is a STRUCT

        Returns:
            SqlTypeEnum: SqlType.STRUCT
        """
        return SqlTypeEnum.STRUCT

Classes

class Field (sql_type: SqlType, name: str)

Represents a field of a struct.

Attributes

sql_type : SqlType
The type of the field.
name : str
The name of the field.
Expand source code
@dataclass
class Field:
    """
    Represents a field of a struct.

    Attributes:
        sql_type (SqlType): The type of the field.
        name (str): The name of the field.
    """
    sql_type: SqlType
    name: str

Class variables

var name : str
var sql_typeSqlType
class StructSqlType (fields: List[Field])

Represents a struct, containing zero or more fields.

Attributes

fields : List[Field]
The fields of this struct.
Expand source code
@dataclass
class StructSqlType(SqlType):
    """
    Represents a struct, containing zero or more fields.

    Attributes:
        fields (List[Field]): The fields of this struct.
    """
    fields: List[Field]

    def get_sql_type_enum(self) -> SqlTypeEnum:
        """
        SqlType.STRUCT as this is a STRUCT

        Returns:
            SqlTypeEnum: SqlType.STRUCT
        """
        return SqlTypeEnum.STRUCT

Ancestors

Class variables

var fields : List[Field]

Methods

def get_sql_type_enum(self) ‑> SqlTypeEnum

SqlType.STRUCT as this is a STRUCT

Returns

SqlTypeEnum
SqlType.STRUCT
Expand source code
def get_sql_type_enum(self) -> SqlTypeEnum:
    """
    SqlType.STRUCT as this is a STRUCT

    Returns:
        SqlTypeEnum: SqlType.STRUCT
    """
    return SqlTypeEnum.STRUCT