Skip to content

PrimaryKey

Source code in docs_src/capo_m2/types/primary_key.py 
11
12
13
14
15
16
17
class PrimaryKey(TypedDict, closed=True):
    name: NotRequired["str"]
    """<p>A name for the Primary Key.</p>"""
    offset: "capo_m2.types.integer.Integer"
    """<p>A positive integer value representing the offset to mark the start of the primary key in the record byte array.</p>"""
    length: "capo_m2.types.integer.Integer"
    """<p>A strictly positive integer value representing the length of the primary key. </p>"""

length instance-attribute 

length: Integer

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

name instance-attribute 

name: NotRequired[str]

A name for the Primary Key.

offset instance-attribute 

offset: Integer

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