Schema

Objects representing a database schema.

Checkbox

Bases: PropertyObject

Defines the checkbox configuration for a database property.

Source code in src/notional/schema.py

class Checkbox(PropertyObject, type="checkbox"):
    """Defines the checkbox configuration for a database property."""

    checkbox: Any = {}

CreatedBy

Bases: PropertyObject

Defines the created-by configuration for a database property.

Source code in src/notional/schema.py

class CreatedBy(PropertyObject, type="created_by"):
    """Defines the created-by configuration for a database property."""

    created_by: Any = {}

CreatedTime

Bases: PropertyObject

Defines the created-time configuration for a database property.

Source code in src/notional/schema.py

class CreatedTime(PropertyObject, type="created_time"):
    """Defines the created-time configuration for a database property."""

    created_time: Any = {}

Date

Bases: PropertyObject

Defines the date configuration for a database property.

Source code in src/notional/schema.py

class Date(PropertyObject, type="date"):
    """Defines the date configuration for a database property."""

    date: Any = {}

DualPropertyRelation

Bases: PropertyRelation

Defines a dual-property relation configuration for a database property.

Source code in src/notional/schema.py

class DualPropertyRelation(PropertyRelation, type="dual_property"):
    """Defines a dual-property relation configuration for a database property."""

    class _NestedData(GenericObject):
        synced_property_name: Optional[str] = None
        synced_property_id: Optional[str] = None

    dual_property: _NestedData = _NestedData()

Email

Bases: PropertyObject

Defines the email configuration for a database property.

Source code in src/notional/schema.py

class Email(PropertyObject, type="email"):
    """Defines the email configuration for a database property."""

    email: Any = {}

Files

Bases: PropertyObject

Defines the files configuration for a database property.

Source code in src/notional/schema.py

class Files(PropertyObject, type="files"):
    """Defines the files configuration for a database property."""

    files: Any = {}

Formula

Bases: PropertyObject

Defines the formula configuration for a database property.

Source code in src/notional/schema.py

class Formula(PropertyObject, type="formula"):
    """Defines the formula configuration for a database property."""

    class _NestedData(GenericObject):
        expression: str = None

    formula: _NestedData = _NestedData()

Function

Bases: str, Enum

Standard aggregation functions.

Source code in src/notional/schema.py

class Function(str, Enum):
    """Standard aggregation functions."""

    COUNT = "count"
    COUNT_VALUES = "count_values"
    COUNT_PER_GROUP = "count_per_group"

    EMPTY = "empty"
    NOT_EMPTY = "not_empty"

    CHECKED = "checked"
    UNCHECKED = "unchecked"

    PERCENT_EMPTY = "percent_empty"
    PERCENT_NOT_EMPTY = "percent_not_empty"
    PERCENT_CHECKED = "percent_checked"
    PERCENT_PER_GROUP = "percent_per_group"

    AVERAGE = "average"
    MIN = "min"
    MAX = "max"
    MEDIAN = "median"
    RANGE = "range"
    SUM = "sum"

    DATE_RANGE = "date_range"
    EARLIEST_DATE = "earliest_date"
    LATEST_DATE = "latest_date"

    SHOW_ORIGINAL = "show_original"
    SHOW_UNIQUE = "show_unique"
    UNIQUE = "unique"

LastEditedBy

Bases: PropertyObject

Defines the last-edited-by configuration for a database property.

Source code in src/notional/schema.py

class LastEditedBy(PropertyObject, type="last_edited_by"):
    """Defines the last-edited-by configuration for a database property."""

    last_edited_by: Any = {}

LastEditedTime

Bases: PropertyObject

Defines the last-edited-time configuration for a database property.

Source code in src/notional/schema.py

class LastEditedTime(PropertyObject, type="last_edited_time"):
    """Defines the last-edited-time configuration for a database property."""

    last_edited_time: Any = {}

MultiSelect

Bases: PropertyObject

Defines the multi-select configuration for a database property.

Source code in src/notional/schema.py

class MultiSelect(PropertyObject, type="multi_select"):
    """Defines the multi-select configuration for a database property."""

    class _NestedData(GenericObject):
        options: List[SelectOption] = []

    multi_select: _NestedData = _NestedData()

Number

Bases: PropertyObject

Defines the number configuration for a database property.

Source code in src/notional/schema.py

class Number(PropertyObject, type="number"):
    """Defines the number configuration for a database property."""

    class _NestedData(GenericObject):
        format: NumberFormat = NumberFormat.NUMBER

        # leads to better error messages, see
        # https://github.com/pydantic/pydantic/issues/355
        @pydantic.validator("format", pre=True)
        def validate_enum_field(cls, field: str):
            return NumberFormat(field)

    number: _NestedData = _NestedData()

    @classmethod
    def __compose__(cls, format):
        """Create a `Number` object with the expected format."""
        return cls(number=cls._NestedData(format=format))

__compose__(format) classmethod

Create a Number object with the expected format.

Source code in src/notional/schema.py

@classmethod
def __compose__(cls, format):
    """Create a `Number` object with the expected format."""
    return cls(number=cls._NestedData(format=format))

NumberFormat

Bases: str, Enum

Available number formats in Notion.

Source code in src/notional/schema.py

class NumberFormat(str, Enum):
    """Available number formats in Notion."""

    NUMBER = "number"
    NUMBER_WITH_COMMAS = "number_with_commas"
    PERCENT = "percent"
    DOLLAR = "dollar"
    CANADIAN_DOLLAR = "canadian_dollar"
    EURO = "euro"
    POUND = "pound"
    YEN = "yen"
    RUBLE = "ruble"
    RUPEE = "rupee"
    WON = "won"
    YUAN = "yuan"
    REAL = "real"
    LIRA = "lira"
    RUPIAH = "rupiah"
    FRANC = "franc"
    HONG_KONG_DOLLAR = "hong_kong_dollar"
    NEW_ZEALAND_DOLLAR = "new_zealand_dollar"
    KRONA = "krona"
    NORWEGIAN_KRONE = "norwegian_krone"
    MEXICAN_PESO = "mexican_peso"
    RAND = "rand"
    NEW_TAIWAN_DOLLAR = "new_taiwan_dollar"
    DANISH_KRONE = "danish_krone"
    ZLOTY = "zloty"
    BAHT = "baht"
    FORINT = "forint"
    KORUNA = "koruna"
    SHEKEL = "shekel"
    CHILEAN_PESO = "chilean_peso"
    PHILIPPINE_PESO = "philippine_peso"
    DIRHAM = "dirham"
    COLOMBIAN_PESO = "colombian_peso"
    RIYAL = "riyal"
    RINGGIT = "ringgit"
    LEU = "leu"
    ARGENTINE_PESO = "argentine_peso"
    URUGUAYAN_PESO = "uruguayan_peso"

People

Bases: PropertyObject

Defines the people configuration for a database property.

Source code in src/notional/schema.py

class People(PropertyObject, type="people"):
    """Defines the people configuration for a database property."""

    people: Any = {}

PhoneNumber

Bases: PropertyObject

Defines the phone number configuration for a database property.

Source code in src/notional/schema.py

class PhoneNumber(PropertyObject, type="phone_number"):
    """Defines the phone number configuration for a database property."""

    phone_number: Any = {}

PropertyObject

Bases: TypedObject

Base class for Notion property objects.

Source code in src/notional/schema.py

class PropertyObject(TypedObject):
    """Base class for Notion property objects."""

    id: Optional[str] = None
    name: Optional[str] = None

PropertyRelation

Bases: TypedObject

Defines common configuration for a property relation.

Source code in src/notional/schema.py

class PropertyRelation(TypedObject):
    """Defines common configuration for a property relation."""

    database_id: UUID = None

Relation

Bases: PropertyObject

Defines the relation configuration for a database property.

Source code in src/notional/schema.py

class Relation(PropertyObject, type="relation"):
    """Defines the relation configuration for a database property."""

    relation: PropertyRelation = PropertyRelation()

RichText

Bases: PropertyObject

Defines the rich text configuration for a database property.

Source code in src/notional/schema.py

class RichText(PropertyObject, type="rich_text"):
    """Defines the rich text configuration for a database property."""

    rich_text: Any = {}

Rollup

Bases: PropertyObject

Defines the rollup configuration for a database property.

Source code in src/notional/schema.py

class Rollup(PropertyObject, type="rollup"):
    """Defines the rollup configuration for a database property."""

    class _NestedData(GenericObject):
        function: Function = Function.COUNT

        relation_property_name: Optional[str] = None
        relation_property_id: Optional[str] = None

        rollup_property_name: Optional[str] = None
        rollup_property_id: Optional[str] = None

        # leads to better error messages, see
        # https://github.com/pydantic/pydantic/issues/355
        @pydantic.validator("function", pre=True)
        def validate_enum_field(cls, field: str):
            return Function(field)

    rollup: _NestedData = _NestedData()

Select

Bases: PropertyObject

Defines the select configuration for a database property.

Source code in src/notional/schema.py

class Select(PropertyObject, type="select"):
    """Defines the select configuration for a database property."""

    class _NestedData(GenericObject):
        options: List[SelectOption] = []

    select: _NestedData = _NestedData()

    @classmethod
    def __compose__(cls, options):
        """Create a `Select` object from the list of `SelectOption`'s."""
        return cls(select=cls._NestedData(options=options))

__compose__(options) classmethod

Create a Select object from the list of SelectOption's.

Source code in src/notional/schema.py

@classmethod
def __compose__(cls, options):
    """Create a `Select` object from the list of `SelectOption`'s."""
    return cls(select=cls._NestedData(options=options))

SelectOption

Bases: GenericObject

Options for select & multi-select objects.

Source code in src/notional/schema.py

class SelectOption(GenericObject):
    """Options for select & multi-select objects."""

    name: str
    id: str = None
    color: str = Color.DEFAULT

    @classmethod
    def __compose__(cls, name, color=Color.DEFAULT):
        """Create a `SelectOption` object from the given name and color."""
        return cls(name=name, color=color)

__compose__(name, color=Color.DEFAULT) classmethod

Create a SelectOption object from the given name and color.

Source code in src/notional/schema.py

@classmethod
def __compose__(cls, name, color=Color.DEFAULT):
    """Create a `SelectOption` object from the given name and color."""
    return cls(name=name, color=color)

SinglePropertyRelation

Bases: PropertyRelation

Defines a single-property relation configuration for a database property.

Source code in src/notional/schema.py

class SinglePropertyRelation(PropertyRelation, type="single_property"):
    """Defines a single-property relation configuration for a database property."""

    single_property: Any = {}

    @classmethod
    def __compose__(cls, dbref):
        """Create a `single_property` relation using the target database reference.

        `dbref` must be either a string or UUID.
        """

        return Relation(relation=SinglePropertyRelation(database_id=dbref))

__compose__(dbref) classmethod

Create a single_property relation using the target database reference.

dbref must be either a string or UUID.

Source code in src/notional/schema.py

@classmethod
def __compose__(cls, dbref):
    """Create a `single_property` relation using the target database reference.

    `dbref` must be either a string or UUID.
    """

    return Relation(relation=SinglePropertyRelation(database_id=dbref))

Status

Bases: PropertyObject

Defines the status configuration for a database property.

Source code in src/notional/schema.py

class Status(PropertyObject, type="status"):
    """Defines the status configuration for a database property."""

    status: Any = {}

Title

Bases: PropertyObject

Defines the title configuration for a database property.

Source code in src/notional/schema.py

class Title(PropertyObject, type="title"):
    """Defines the title configuration for a database property."""

    title: Any = {}

URL

Bases: PropertyObject

Defines the URL configuration for a database property.

Source code in src/notional/schema.py

class URL(PropertyObject, type="url"):
    """Defines the URL configuration for a database property."""

    url: Any = {}