protocol library

Classes

AuthKey
Provides a method of access for a user to authenticate with the server.
AuthKeyInclude
AuthKeyIncludeList
AuthKeyRepository
AuthKeyTable
BulkData
BulkQueryColumnDescription
BulkQueryResult
CacheInfo
Provides high level information about a cache.
CachesInfo
High level information about the caches.
CloudStorageDirectUploadEntry
Connects a table for handling uploading of files.
CloudStorageDirectUploadEntryInclude
CloudStorageDirectUploadEntryIncludeList
CloudStorageDirectUploadEntryRepository
CloudStorageDirectUploadEntryTable
CloudStorageEntry
An entry in the database for an uploaded file.
CloudStorageEntryInclude
CloudStorageEntryIncludeList
CloudStorageEntryRepository
CloudStorageEntryTable
ClusterInfo
Information about a cluster of servers.
ClusterServerInfo
Information about a single server in a cluster.
ColumnDefinition
The definition of a (desired) column in the database.
ColumnMigration
DatabaseDefinition
Defines the structure of the database used by Serverpod.
DatabaseDefinitions
Defines the current state of the database, including information about installed modules and migrations.
DatabaseMigration
DatabaseMigrationAction
DatabaseMigrationVersion
Represents a version of a database migration.
DatabaseMigrationVersionInclude
DatabaseMigrationVersionIncludeList
DatabaseMigrationVersionRepository
DatabaseMigrationVersionTable
DatabaseMigrationWarning
DistributedCacheEntry
An entry in the distributed cache.
Filter
FilterConstraint
ForeignKeyDefinition
Represents a foreign key.
FutureCallEntry
A serialized future call with bindings to the database.
FutureCallEntryInclude
FutureCallEntryIncludeList
FutureCallEntryRepository
FutureCallEntryTable
IndexDefinition
The definition of a (desired) index in the database.
IndexElementDefinition
Defines an element of an index.
LogEntry
Bindings to a log entry in the database.
LogEntryInclude
LogEntryIncludeList
LogEntryRepository
LogEntryTable
LogResult
A list of log entries, used to return logging data.
LogSettings
Log settings for the server.
LogSettingsOverride
Information about an override for log settings for either an entire endpoint or a specific method.
MessageLogEntry
A log entry for a message sent in a streaming session.
MessageLogEntryInclude
MessageLogEntryIncludeList
MessageLogEntryRepository
MessageLogEntryTable
MethodInfo
Information about a server method.
MethodInfoInclude
MethodInfoIncludeList
MethodInfoRepository
MethodInfoTable
Protocol
QueryLogEntry
A log entry for a database query.
QueryLogEntryInclude
QueryLogEntryIncludeList
QueryLogEntryRepository
QueryLogEntryTable
ReadWriteTestEntry
Database mapping for a read/write test that is performed by the default health checks.
ReadWriteTestEntryInclude
ReadWriteTestEntryIncludeList
ReadWriteTestEntryRepository
ReadWriteTestEntryTable
RuntimeSettings
Runtime settings of the server.
RuntimeSettingsInclude
RuntimeSettingsIncludeList
RuntimeSettingsRepository
RuntimeSettingsTable
ServerHealthConnectionInfo
Represents a snapshot of the number of open connections the server currently is handling. An entry is written every minute for each server. All health data can be accessed through Serverpod Insights.
ServerHealthConnectionInfoInclude
ServerHealthConnectionInfoIncludeList
ServerHealthConnectionInfoRepository
ServerHealthConnectionInfoTable
ServerHealthMetric
Represents a snapshot of a specific health metric. An entry is written every minute for each server. All health data can be accessed through Serverpod Insights.
ServerHealthMetricInclude
ServerHealthMetricIncludeList
ServerHealthMetricRepository
ServerHealthMetricTable
ServerHealthResult
Information about health and connection metrics.
SessionLogEntry
Log entry for a session.
SessionLogEntryInclude
SessionLogEntryIncludeList
SessionLogEntryRepository
SessionLogEntryTable
SessionLogFilter
The log filter is used when searching for specific log entries.
SessionLogInfo
Compounded information about a session log.
SessionLogResult
A list of SessionLogInfo.
TableDefinition
The definition of a (desired) table in the database.
TableMigration

Enums

ColumnType
All the types, that are possible for columns. Contains all the values of TypeDefinition.databaseType
DatabaseMigrationActionType
DatabaseMigrationWarningType
EnumSerialization
FilterConstraintType
ForeignKeyAction
Describes how to react if the row a foreign key refers to changes / is deleted.
ForeignKeyMatchType
Defines how a foreign key should be matched.
IndexElementDefinitionType
Used to specify how the definition of an IndexElementDefinition should be interpreted.
LogLevel
Represents different log levels.