Module: index_decl

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# 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 dataclasses import dataclass
from cl.runtime.records.dataclasses_extensions import field
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.schema.index_sort_order_enum import IndexSortOrderEnum


@dataclass(slots=True, kw_only=True)
class IndexDecl:
    """Index declaration."""

    name: str = missing()
    """Target index element name."""

    direction: IndexSortOrderEnum = missing()
    """Index sort order direction (if not specified ascending sorting will be used)."""

Classes

class IndexDecl (*, name: str = None, direction: IndexSortOrderEnum = None)

Index declaration.

Expand source code

@dataclass(slots=True, kw_only=True)
class IndexDecl:
    """Index declaration."""

    name: str = missing()
    """Target index element name."""

    direction: IndexSortOrderEnum = missing()
    """Index sort order direction (if not specified ascending sorting will be used)."""

Fields

var direction -> IndexSortOrderEnum: Index sort order direction (if not specified ascending sorting will be used).
var name -> str: Target index element name.