ConnectionConfig
in package
This class is automatically generated to help in creating a config.
Table of Contents
Properties
- $_usedProperties : mixed
- $applicationName : mixed
- $autoCommit : mixed
- $charset : mixed
- $connectstring : mixed
- $dbname : mixed
- $dbnameSuffix : mixed
- $defaultDbname : mixed
- $defaultTableOptions : mixed
- $driver : mixed
- $driverClass : mixed
- $host : mixed
- $instancename : mixed
- $keepReplica : mixed
- $keepSlave : mixed
- $logging : mixed
- $mappingTypes : mixed
- $memory : mixed
- $multipleActiveResultSets : mixed
- $options : mixed
- $overrideUrl : mixed
- $password : mixed
- $path : mixed
- $persistent : mixed
- $platformService : mixed
- $pooled : mixed
- $port : mixed
- $profiling : mixed
- $profilingCollectBacktrace : mixed
- $profilingCollectSchemaErrors : mixed
- $protocol : mixed
- $replicas : mixed
- $schemaFilter : mixed
- $schemaManagerFactory : mixed
- $server : mixed
- $serverVersion : mixed
- $service : mixed
- $servicename : mixed
- $sessionMode : mixed
- $slaves : mixed
- $sslcert : mixed
- $sslcrl : mixed
- $sslkey : mixed
- $sslmode : mixed
- $sslrootcert : mixed
- $unixSocket : mixed
- $url : mixed
- $user : mixed
- $useSavepoints : mixed
- $wrapperClass : mixed
Methods
- __construct() : mixed
- applicationName() : $this
- autoCommit() : $this
- charset() : $this
- connectstring() : $this
- Complete Easy Connect connection descriptor, see https://docs.oracle.com/database/121/NETAG/naming.htm.When using this option, you will still need to provide the user and password parameters, but the other parameters will no longer be used. Note that when using this parameter, the getHost and getPort methods from Doctrine\DBAL\Connection will no longer function as expected.
- dbname() : $this
- dbnameSuffix() : $this
- defaultDbname() : $this
- Override the default database (postgres) to connect to for PostgreSQL connexion.
- defaultTableOption() : $this
- driver() : $this
- driverClass() : $this
- host() : $this
- Defaults to "localhost" at runtime.
- instancename() : $this
- Optional parameter, complete whether to add the INSTANCE_NAME parameter in the connection. It is generally used to connect to an Oracle RAC server to select the name of a particular instance.
- keepReplica() : $this
- keepSlave() : $this
- logging() : $this
- mappingType() : $this
- memory() : $this
- multipleActiveResultSets() : $this
- Configuring MultipleActiveResultSets for the pdo_sqlsrv driver
- option() : $this
- overrideUrl() : $this
- password() : $this
- Defaults to null at runtime.
- path() : $this
- persistent() : $this
- True to use as persistent connection for the ibm_db2 driver
- platformService() : $this
- pooled() : $this
- True to use a pooled server with the oci8/pdo_oracle driver
- port() : $this
- Defaults to null at runtime.
- profiling() : $this
- profilingCollectBacktrace() : $this
- Enables collecting backtraces when profiling is enabled
- profilingCollectSchemaErrors() : $this
- Enables collecting schema errors when profiling is enabled
- protocol() : $this
- The protocol to use for the ibm_db2 driver (default to TCPIP if omitted)
- replica() : ReplicaConfig|$this
- schemaFilter() : $this
- schemaManagerFactory() : $this
- server() : $this
- The name of a running database server to connect to for SQL Anywhere.
- serverVersion() : $this
- service() : $this
- True to use SERVICE_NAME as connection parameter instead of SID for Oracle
- servicename() : $this
- Overrules dbname parameter if given and used as SERVICE_NAME or SID connection parameter for Oracle depending on the service parameter.
- sessionMode() : $this
- The session mode to use for the oci8 driver
- slave() : SlaveConfig|$this
- sslcert() : $this
- The path to the SSL client certificate file for PostgreSQL.
- sslcrl() : $this
- The file name of the SSL certificate revocation list for PostgreSQL.
- sslkey() : $this
- The path to the SSL client key file for PostgreSQL.
- sslmode() : $this
- Determines whether or with what priority a SSL TCP/IP connection will be negotiated with the server for PostgreSQL.
- sslrootcert() : $this
- The name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server's certificate will be verified to be signed by one of these authorities.
- toArray() : array<string|int, mixed>
- unixSocket() : $this
- The unix socket to use for MySQL
- url() : $this
- A URL with connection information; any parameter value parsed from this string will override explicitly set parameters
- user() : $this
- Defaults to "root" at runtime.
- useSavepoints() : $this
- Use savepoints for nested transactions
- wrapperClass() : $this
Properties
$_usedProperties
private
mixed
$_usedProperties
= []
$applicationName
private
mixed
$applicationName
$autoCommit
private
mixed
$autoCommit
$charset
private
mixed
$charset
$connectstring
private
mixed
$connectstring
$dbname
private
mixed
$dbname
$dbnameSuffix
private
mixed
$dbnameSuffix
$defaultDbname
private
mixed
$defaultDbname
$defaultTableOptions
private
mixed
$defaultTableOptions
$driver
private
mixed
$driver
$driverClass
private
mixed
$driverClass
$host
private
mixed
$host
$instancename
private
mixed
$instancename
$keepReplica
private
mixed
$keepReplica
$keepSlave
private
mixed
$keepSlave
$logging
private
mixed
$logging
$mappingTypes
private
mixed
$mappingTypes
$memory
private
mixed
$memory
$multipleActiveResultSets
private
mixed
$multipleActiveResultSets
$options
private
mixed
$options
$overrideUrl
private
mixed
$overrideUrl
$password
private
mixed
$password
$path
private
mixed
$path
$persistent
private
mixed
$persistent
$platformService
private
mixed
$platformService
$pooled
private
mixed
$pooled
$port
private
mixed
$port
$profiling
private
mixed
$profiling
$profilingCollectBacktrace
private
mixed
$profilingCollectBacktrace
$profilingCollectSchemaErrors
private
mixed
$profilingCollectSchemaErrors
$protocol
private
mixed
$protocol
$replicas
private
mixed
$replicas
$schemaFilter
private
mixed
$schemaFilter
$schemaManagerFactory
private
mixed
$schemaManagerFactory
$server
private
mixed
$server
$serverVersion
private
mixed
$serverVersion
$service
private
mixed
$service
$servicename
private
mixed
$servicename
$sessionMode
private
mixed
$sessionMode
$slaves
private
mixed
$slaves
$sslcert
private
mixed
$sslcert
$sslcrl
private
mixed
$sslcrl
$sslkey
private
mixed
$sslkey
$sslmode
private
mixed
$sslmode
$sslrootcert
private
mixed
$sslrootcert
$unixSocket
private
mixed
$unixSocket
$url
private
mixed
$url
$user
private
mixed
$user
$useSavepoints
private
mixed
$useSavepoints
$wrapperClass
private
mixed
$wrapperClass
Methods
__construct()
public
__construct([array<string|int, mixed> $value = [] ]) : mixed
Parameters
- $value : array<string|int, mixed> = []
applicationName()
public
applicationName(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisautoCommit()
public
autoCommit(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thischarset()
public
charset(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisconnectstring()
Complete Easy Connect connection descriptor, see https://docs.oracle.com/database/121/NETAG/naming.htm.When using this option, you will still need to provide the user and password parameters, but the other parameters will no longer be used. Note that when using this parameter, the getHost and getPort methods from Doctrine\DBAL\Connection will no longer function as expected.
public
connectstring(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisdbname()
public
dbname(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisdbnameSuffix()
public
dbnameSuffix(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisdefaultDbname()
Override the default database (postgres) to connect to for PostgreSQL connexion.
public
defaultDbname(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisdefaultTableOption()
public
defaultTableOption(string $name, mixed $value) : $this
Parameters
- $name : string
- $value : mixed
Return values
$thisdriver()
public
driver(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisdriverClass()
public
driverClass(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thishost()
Defaults to "localhost" at runtime.
public
host(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisinstancename()
Optional parameter, complete whether to add the INSTANCE_NAME parameter in the connection. It is generally used to connect to an Oracle RAC server to select the name of a particular instance.
public
instancename(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thiskeepReplica()
public
keepReplica(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thiskeepSlave()
public
keepSlave(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thislogging()
public
logging(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thismappingType()
public
mappingType(string $name, mixed $value) : $this
Parameters
- $name : string
- $value : mixed
Return values
$thismemory()
public
memory(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thismultipleActiveResultSets()
Configuring MultipleActiveResultSets for the pdo_sqlsrv driver
public
multipleActiveResultSets(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisoption()
public
option(string $key, mixed $value) : $this
Parameters
- $key : string
- $value : mixed
Return values
$thisoverrideUrl()
public
overrideUrl(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thispassword()
Defaults to null at runtime.
public
password(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thispath()
public
path(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thispersistent()
True to use as persistent connection for the ibm_db2 driver
public
persistent(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisplatformService()
public
platformService(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thispooled()
True to use a pooled server with the oci8/pdo_oracle driver
public
pooled(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisport()
Defaults to null at runtime.
public
port(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisprofiling()
public
profiling(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisprofilingCollectBacktrace()
Enables collecting backtraces when profiling is enabled
public
profilingCollectBacktrace(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisprofilingCollectSchemaErrors()
Enables collecting schema errors when profiling is enabled
public
profilingCollectSchemaErrors(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisprotocol()
The protocol to use for the ibm_db2 driver (default to TCPIP if omitted)
public
protocol(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisreplica()
public
replica(string $name[, mixed $value = [] ]) : ReplicaConfig|$this
Parameters
- $name : string
- $value : mixed = []
Return values
ReplicaConfig|$thisschemaFilter()
public
schemaFilter(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisschemaManagerFactory()
public
schemaManagerFactory(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisserver()
The name of a running database server to connect to for SQL Anywhere.
public
server(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisserverVersion()
public
serverVersion(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisservice()
True to use SERVICE_NAME as connection parameter instead of SID for Oracle
public
service(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thisservicename()
Overrules dbname parameter if given and used as SERVICE_NAME or SID connection parameter for Oracle depending on the service parameter.
public
servicename(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thissessionMode()
The session mode to use for the oci8 driver
public
sessionMode(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisslave()
public
slave(string $name[, mixed $value = [] ]) : SlaveConfig|$this
Parameters
- $name : string
- $value : mixed = []
Return values
SlaveConfig|$thissslcert()
The path to the SSL client certificate file for PostgreSQL.
public
sslcert(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thissslcrl()
The file name of the SSL certificate revocation list for PostgreSQL.
public
sslcrl(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thissslkey()
The path to the SSL client key file for PostgreSQL.
public
sslkey(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thissslmode()
Determines whether or with what priority a SSL TCP/IP connection will be negotiated with the server for PostgreSQL.
public
sslmode(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thissslrootcert()
The name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server's certificate will be verified to be signed by one of these authorities.
public
sslrootcert(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thistoArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>unixSocket()
The unix socket to use for MySQL
public
unixSocket(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisurl()
A URL with connection information; any parameter value parsed from this string will override explicitly set parameters
public
url(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisuser()
Defaults to "root" at runtime.
public
user(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed
Tags
Return values
$thisuseSavepoints()
Use savepoints for nested transactions
public
useSavepoints(ParamConfigurator|bool $value) : $this
Parameters
- $value : ParamConfigurator|bool
Tags
Return values
$thiswrapperClass()
public
wrapperClass(ParamConfigurator|mixed $value) : $this
Parameters
- $value : ParamConfigurator|mixed