ServerpodEnv enum

The default environment variables used by the server.

Inheritance
Available extensions

Values

databaseHost → const ServerpodEnv

The address for the database.

databasePort → const ServerpodEnv

The port for the database.

databaseName → const ServerpodEnv

The name of the database.

databaseUser → const ServerpodEnv

The user for the database.

databaseSearchPaths → const ServerpodEnv

The default schema for the database.

databaseRequireSsl → const ServerpodEnv

Toggle to require SSL for the database.

databaseIsUnixSocket → const ServerpodEnv

Toggle to use a Unix socket for the database.

redisHost → const ServerpodEnv

The address to the redis broker.

redisPort → const ServerpodEnv

The port for the redis broker.

redisUser → const ServerpodEnv

The user for the redis broker.

redisEnabled → const ServerpodEnv

Toggle to enable the redis broker.

redisRequireSsl → const ServerpodEnv

Toggle to require SSL for the redis broker.

apiPort → const ServerpodEnv

The local port for the api server.

apiPublicHost → const ServerpodEnv

The public address to the api server.

apiPublicPort → const ServerpodEnv

The public port for the api server.

apiPublicScheme → const ServerpodEnv

The public scheme for the api server.

insightsPort → const ServerpodEnv

The local port for the insights server.

insightsPublicHost → const ServerpodEnv

The public address to the insights server.

insightsPublicPort → const ServerpodEnv

The public port for the insights server.

insightsPublicScheme → const ServerpodEnv

The public scheme for the insights server.

webPort → const ServerpodEnv

The local port for the web server.

webPublicHost → const ServerpodEnv

The public address to the web server.

webPublicPort → const ServerpodEnv

The public port for the web server.

webPublicScheme → const ServerpodEnv

The public scheme for the web server.

maxRequestSize → const ServerpodEnv

The maximum request size for the server.

futureCallConcurrencyLimit → const ServerpodEnv

The maximum number of concurrent running future calls.

futureCallScanInterval → const ServerpodEnv

How long to wait before checking the queue again in milliseconds.

futureCallExecutionEnabled → const ServerpodEnv

Toggle to disable future call execution.

sessionPersistentLogEnabled → const ServerpodEnv

True if session persistent logging is enabled.

sessionConsoleLogEnabled → const ServerpodEnv

True if session console logging is enabled.

sessionConsoleLogFormat → const ServerpodEnv

The format for the console log.

runMode → const ServerpodEnv

The run mode of the server.

role → const ServerpodEnv

The role of the server.

loggingMode → const ServerpodEnv

The logging mode of the server.

serverId → const ServerpodEnv

The id of the server.

applyMigrations → const ServerpodEnv

If true, the server will apply database migrations on startup.

applyRepairMigration → const ServerpodEnv

If true, the server will apply database repair migration on startup.

Properties

configKey String
The key used in the environment configuration file.
no setter
envVariable String
The environment variable name for the key.
no setter
hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<ServerpodEnv>
A constant List of the values in this enum, in order of their declaration.