dse.cqlengine.usertype - Model classes for User Defined Types

UserType

class UserType

This class is used to model User Defined Types. To define a type, declare a class inheriting from this, and assign field types as class attributes:

Copy
# connect with default keyspace ...

from dse.cqlengine.columns import Text, Integer
from dse.cqlengine.usertype import UserType

class address(UserType):
    street = Text()
    zipcode = Integer()

from dse.cqlengine import management
management.sync_type(address)

Please see User Defined Types for a complete example and discussion.

Attributes

__type_name__
= None

Optional. Sets the name of the CQL type for this type.

If not specified, the type name will be the name of the class, with it’s module name as it’s prefix.