Documentation

ReplicaConfig
in package

This class is automatically generated to help in creating a config.

Table of Contents

Properties

$_usedProperties  : mixed
$applicationName  : mixed
$charset  : mixed
$connectstring  : mixed
$dbname  : mixed
$dbnameSuffix  : mixed
$defaultDbname  : mixed
$host  : mixed
$instancename  : mixed
$memory  : mixed
$multipleActiveResultSets  : mixed
$overrideUrl  : mixed
$password  : mixed
$path  : mixed
$persistent  : mixed
$pooled  : mixed
$port  : mixed
$protocol  : mixed
$server  : mixed
$service  : mixed
$servicename  : mixed
$sessionMode  : mixed
$sslcert  : mixed
$sslcrl  : mixed
$sslkey  : mixed
$sslmode  : mixed
$sslrootcert  : mixed
$unixSocket  : mixed
$url  : mixed
$user  : mixed
$useSavepoints  : mixed

Methods

__construct()  : mixed
applicationName()  : $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.
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.
memory()  : $this
multipleActiveResultSets()  : $this
Configuring MultipleActiveResultSets for the pdo_sqlsrv driver
overrideUrl()  : $this
password()  : $this
Defaults to null at runtime.
path()  : $this
persistent()  : $this
True to use as persistent connection for the ibm_db2 driver
pooled()  : $this
True to use a pooled server with the oci8/pdo_oracle driver
port()  : $this
Defaults to null at runtime.
protocol()  : $this
The protocol to use for the ibm_db2 driver (default to TCPIP if omitted)
server()  : $this
The name of a running database server to connect to for SQL Anywhere.
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
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

Properties

$multipleActiveResultSets

private mixed $multipleActiveResultSets

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

defaultDbname()

Override the default database (postgres) to connect to for PostgreSQL connexion.

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

null

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

multipleActiveResultSets()

Configuring MultipleActiveResultSets for the pdo_sqlsrv driver

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

null

Return values
$this

overrideUrl()

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

null

deprecated

The "doctrine.dbal.override_url" configuration key is deprecated.

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