Documentation

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

$profilingCollectSchemaErrors

private mixed $profilingCollectSchemaErrors

Methods

__construct()

public __construct([array<string|int, mixed> $value = [] ]) : mixed
Parameters
$value : array<string|int, mixed> = []

connectstring()

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
default

null

Return values
$this

defaultTableOption()

public defaultTableOption(string $name, mixed $value) : $this
Parameters
$name : string
$value : mixed
Return values
$this

instancename()

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
default

null

Return values
$this

keepSlave()

public keepSlave(ParamConfigurator|bool $value) : $this
Parameters
$value : ParamConfigurator|bool
Tags
default

null

deprecated

The "keep_slave" configuration key is deprecated since doctrine-bundle 2.2. Use the "keep_replica" configuration key instead.

Return values
$this

mappingType()

public mappingType(string $name, mixed $value) : $this
Parameters
$name : string
$value : mixed
Return values
$this

multipleActiveResultSets()

Configuring MultipleActiveResultSets for the pdo_sqlsrv driver

public multipleActiveResultSets(ParamConfigurator|bool $value) : $this
Parameters
$value : ParamConfigurator|bool
Tags
default

null

Return values
$this

option()

public option(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

platformService()

public platformService(ParamConfigurator|mixed $value) : $this
Parameters
$value : ParamConfigurator|mixed
Tags
default

null

deprecated

The "platform_service" configuration key is deprecated since doctrine-bundle 2.9. DBAL 4 will not support setting a custom platform via connection params anymore.

Return values
$this

profilingCollectSchemaErrors()

Enables collecting schema errors when profiling is enabled

public profilingCollectSchemaErrors(ParamConfigurator|bool $value) : $this
Parameters
$value : ParamConfigurator|bool
Tags
default

true

Return values
$this

servicename()

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
default

null

Return values
$this

sslmode()

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
default

null

Return values
$this

sslrootcert()

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
default

null

Return values
$this

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

url()

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
default

null

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results