Skip to content

AlternateKey

Source code in docs_src/capo_m2/types/alternate_key.py 
12
13
14
15
16
17
18
19
20
class AlternateKey(TypedDict, closed=True):
    name: NotRequired["str"]
    """<p>The name of the alternate key.</p>"""
    offset: "capo_m2.types.integer.Integer"
    """<p>A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.</p>"""
    length: "capo_m2.types.integer.Integer"
    """<p>A strictly positive integer value representing the length of the alternate key.</p>"""
    allow_duplicates: "capo_m2.types.boolean.Boolean"
    """<p>Indicates whether the alternate key values are supposed to be unique for the given data set.</p>"""

allow_duplicates instance-attribute 

allow_duplicates: Boolean

Indicates whether the alternate key values are supposed to be unique for the given data set.

length instance-attribute 

length: Integer

A strictly positive integer value representing the length of the alternate key.

name instance-attribute 

name: NotRequired[str]

The name of the alternate key.

offset instance-attribute 

offset: Integer

A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.