1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
|
# Copyright (c) 2018-2024 Open Text.
# Copyright (c) 2018 Uber Technologies, 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.
# Copyright (c) 2013-2017 Uber Technologies, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from __future__ import print_function, division, absolute_import, annotations
from typing import TYPE_CHECKING, NamedTuple
if TYPE_CHECKING:
from typing import Optional
from ..datatypes import getDisplaySize, getPrecision, getScale
from ..compat import as_str, as_text
# Data of a particular SQL data type might be transmitted in either "text" format or "binary" format.
# The desired format for any column is specified by a format code.
class FormatCode(object):
TEXT = 0
BINARY = 1
class ColumnTuple(NamedTuple):
name: str
type_code: int
display_size: Optional[int]
internal_size: int
precision: Optional[int]
scale: Optional[int]
null_ok: bool
class Column(object):
def __init__(self, col) -> None:
# Describe one query result column
self.name = col['name']
self.type_code = col['data_type_oid']
self.type_name = col['data_type_name']
self.table_oid = col['table_oid']
self.schema_name = col['schema_name']
self.table_name = col['table_name']
self.attribute_number = col['attribute_number']
self.display_size = getDisplaySize(col['data_type_oid'], col['type_modifier'])
self.internal_size = col['data_type_size']
self.precision = getPrecision(col['data_type_oid'], col['type_modifier'])
self.scale = getScale(col['data_type_oid'], col['type_modifier'])
self.null_ok = col['null_ok']
self.is_identity = col['is_identity']
self.format_code = col['format_code']
self.child_columns = None
self.props = ColumnTuple(self.name, self.type_code, self.display_size, self.internal_size,
self.precision, self.scale, self.null_ok)
def add_child_column(self, col: Column) -> None:
"""
Complex types involve multiple columns arranged in a hierarchy of parents and children.
Each parent column stores references to child columns in a list.
"""
if self.child_columns is None:
self.child_columns = []
self.child_columns.append(col)
def debug_info(self) -> str:
childs = ""
if self.child_columns:
c = ", ".join([col.debug_info() for col in self.child_columns])
childs = f", child_columns=[{c}]"
return (f"Column(name={self.name}, data_type_oid={self.type_code}, data_type_name={self.type_name}, "
f"schema_name={self.schema_name}, table_name={self.table_name}, table_oid={self.table_oid}, "
f"attribute_number={self.attribute_number}, precision={self.precision}, scale={self.scale}, "
f"null_ok={self.null_ok}, is_identity={self.is_identity}, format_code={self.format_code}, "
f"internal_size={self.internal_size}, display_size={self.display_size}{childs}"
")")
def __str__(self):
return as_str(str(self.props))
def __unicode__(self):
return as_text(str(self.props))
def __repr__(self):
return as_str(str(self.props))
def __iter__(self):
for prop in self.props:
yield prop
def __getitem__(self, key):
return self.props[key]
def __len__(self):
return len(self.props)
|