orionis.orm.schema.types.String

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class String(ColumnDefinition): (source)

The base for all string and character types. In SQL, VARCHAR.

Method	`__init__`	Create a string-holding type.
Class Variable	`__slots__`	Undocumented

def __init__(self, length: int | None = DEFAULT_STRING_LENGTH, collation: str | None = None): (source) ¶

Create a string-holding type.

Parameters
length:`int or None, optional`	Length for the column for use in DDL and CAST expressions.
collation:`str or None, optional`	Column-level collation for use in DDL and CAST expressions.

Returns
`None`	This method does not return a value.

Raises
`ValueError`	If the length is not a positive integer or None.

Undocumented