.database¶
cattle_grid.database ¶
account ¶
Account ¶
Bases: Base
Represents an account
Source code in cattle_grid/database/account.py
ActorForAccount ¶
Bases: Base
Represents the actor associated with an account
Source code in cattle_grid/database/account.py
activity_pub ¶
Base ¶
Bases: AsyncAttrs
, DeclarativeBase
Base model
Credential ¶
Bases: Base
Stored credential
Source code in cattle_grid/database/activity_pub.py
actor_id
class-attribute
instance-attribute
¶
actor_id: Mapped[str] = mapped_column(String(256))
The id of the actor the key belongs to
id
class-attribute
instance-attribute
¶
id: Mapped[int] = mapped_column(primary_key=True)
primary key
identifier
class-attribute
instance-attribute
¶
identifier: Mapped[str] = mapped_column(
String(256), unique=True
)
The identifier of the key
secret
class-attribute
instance-attribute
¶
secret: Mapped[str] = mapped_column(Text())
The secret underlying the private key
InboxLocation ¶
Bases: Base
Describes the location of an inbox. Used to send ActivityPub Activities addressed to the actor to the corresponding inbox.
This information is also collected for remote actors.
Source code in cattle_grid/database/activity_pub.py
activity_pub_actor ¶
Actor ¶
Bases: Base
Source code in cattle_grid/database/activity_pub_actor.py
actor_id
class-attribute
instance-attribute
¶
actor_id: Mapped[str] = mapped_column(
String(256), unique=True
)
The id of the actor
automatically_accept_followers
class-attribute
instance-attribute
¶
automatically_accept_followers: Mapped[bool] = (
mapped_column(Boolean())
)
Set to true to indicate cattle_grid should automatically accept follow requests
followers_uri
class-attribute
instance-attribute
¶
followers_uri: Mapped[str] = mapped_column(
String(256), unique=True
)
The uri of the followers collection
following_uri
class-attribute
instance-attribute
¶
following_uri: Mapped[str] = mapped_column(
String(256), unique=True
)
The uri of the following collection
inbox_uri
class-attribute
instance-attribute
¶
inbox_uri: Mapped[str] = mapped_column(
String(256), unique=True
)
The uri of the inbox
outbox_uri
class-attribute
instance-attribute
¶
outbox_uri: Mapped[str] = mapped_column(
String(256), unique=True
)
The uri of the outbox
preferred_username
class-attribute
instance-attribute
¶
preferred_username: Mapped[str] = mapped_column(
String(256), nullable=True
)
The preferred username, used as the username part of the
acct-uri of the actor, i.e. acct:${preferred_username}@domain
.
See RFC 7565 The ‘acct’ URI Scheme.
profile
class-attribute
instance-attribute
¶
profile: Mapped[dict] = mapped_column(JSON())
Additional profile values
public_key
class-attribute
instance-attribute
¶
public_key: Mapped[str] = mapped_column(Text())
The public key
public_key_name
class-attribute
instance-attribute
¶
public_key_name: Mapped[str] = mapped_column(String(256))
The name given to the public key, i.e. the id will be `${actor_id}#${public_key_name}.
status
class-attribute
instance-attribute
¶
status: Mapped[ActorStatus] = mapped_column(String(7))
Represents the status of the actor
ActorStatus ¶
Blocking ¶
Bases: Base
The people the actor is blocking
Source code in cattle_grid/database/activity_pub_actor.py
Follower ¶
Bases: Base
The people that follow the actor
Source code in cattle_grid/database/activity_pub_actor.py
Following ¶
Bases: Base
The people the actor is following
Source code in cattle_grid/database/activity_pub_actor.py
PublicIdentifier ¶
Bases: Base
Public identifier
Source code in cattle_grid/database/activity_pub_actor.py
PublicIdentifierStatus ¶
Bases: StrEnum
Represents the status of the public identifier
Source code in cattle_grid/database/activity_pub_actor.py
StoredActivity ¶
Bases: Base
cattle_grid generates activities under some circumstances (see FIXME). These will be stored in this table
Source code in cattle_grid/database/activity_pub_actor.py
auth ¶
Base ¶
Bases: AsyncAttrs
, DeclarativeBase
Base model
RemoteIdentity ¶
Bases: Base
Stored activity in the database
Source code in cattle_grid/database/auth.py
__tablename__
class-attribute
instance-attribute
¶
name of the table
controller
class-attribute
instance-attribute
¶
controller: Mapped[str] = mapped_column(String(512))
The URI of te controller
id
class-attribute
instance-attribute
¶
id: Mapped[int] = mapped_column(primary_key=True)
The id of the key
key_id
class-attribute
instance-attribute
¶
key_id: Mapped[str] = mapped_column(
String(512), unique=True
)
The URI uniquely identifying the key
public_key
class-attribute
instance-attribute
¶
public_key: Mapped[str] = mapped_column(String(1024))
The public key