Module ksqldb_confluent.types.column

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


@dataclass
class Column:
    """
    Represents a column within a Schema.
    Attributes:
        name (str): The name of this column
        is_key (bool): True, if the column is part of the key of the schema. False Otherwise.
        sql_type (SqlType): The SqlType of the column
    """
    name: str
    is_key: bool
    sql_type: SqlType

    def __repr__(self):
        return f'Column{{Name={self.name},is_key={self.is_key},sql_type={self.sql_type}}}'

Classes

class Column (name: str, is_key: bool, sql_type: SqlType)

Represents a column within a Schema.

Attributes

name : str
The name of this column
is_key : bool
True, if the column is part of the key of the schema. False Otherwise.
sql_type : SqlType
The SqlType of the column
Expand source code
@dataclass
class Column:
    """
    Represents a column within a Schema.
    Attributes:
        name (str): The name of this column
        is_key (bool): True, if the column is part of the key of the schema. False Otherwise.
        sql_type (SqlType): The SqlType of the column
    """
    name: str
    is_key: bool
    sql_type: SqlType

    def __repr__(self):
        return f'Column{{Name={self.name},is_key={self.is_key},sql_type={self.sql_type}}}'

Class variables

var is_key : bool
var name : str
var sql_typeSqlType