1. class
  2. Illuminate
  3. Database
  4. SqlServerConnection

SqlServerConnection

class SqlServerConnection extends Connection (View source)

Traits

DetectsLostConnections

Methods

void
__construct( PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = array())

Create a new database connection instance.

from Connection
void
useDefaultQueryGrammar()

Set the query grammar to the default implementation.

from Connection
void
useDefaultSchemaGrammar()

Set the schema grammar to the default implementation.

from Connection
void
useDefaultPostProcessor()

Set the query post processor to the default implementation.

from Connection
Builder
getSchemaBuilder()

Get a schema builder instance for the connection.

from Connection
Builder
table( string $table)

Begin a fluent query against a database table.

from Connection
Builder
query()

Get a new query builder instance.

from Connection
Expression
raw( mixed $value)

Get a new raw query expression.

from Connection
mixed
selectOne( string $query, array $bindings = array())

Run a select statement and return a single result.

from Connection
array
selectFromWriteConnection( string $query, array $bindings = array())

Run a select statement against the database.

from Connection
array
select( string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement against the database.

from Connection
bool
insert( string $query, array $bindings = array())

Run an insert statement against the database.

from Connection
int
update( string $query, array $bindings = array())

Run an update statement against the database.

from Connection
int
delete( string $query, array $bindings = array())

Run a delete statement against the database.

from Connection
bool
statement( string $query, array $bindings = array())

Execute an SQL statement and return the boolean result.

from Connection
int
affectingStatement( string $query, array $bindings = array())

Run an SQL statement and get the number of rows affected.

from Connection
bool
unprepared( string $query)

Run a raw, unprepared query against the PDO connection.

from Connection
array
prepareBindings( array $bindings)

Prepare the query bindings for execution.

from Connection
mixed
transaction( Closure $callback)

Execute a Closure within a transaction.

void
beginTransaction()

Start a new database transaction.

from Connection
void
commit()

Commit the active database transaction.

from Connection
void
rollBack()

Rollback the active database transaction.

from Connection
int
transactionLevel()

Get the number of active transactions.

from Connection
array
pretend( Closure $callback)

Execute the given callback in "dry run" mode.

from Connection
void
disconnect()

Disconnect from the underlying PDO connection.

from Connection
void
reconnect()

Reconnect to the database.

from Connection
void
logQuery( string $query, array $bindings, float|null $time = null)

Log a query in the connection's query log.

from Connection
void
listen( Closure $callback)

Register a database query listener with the connection.

from Connection
bool
isDoctrineAvailable()

Is Doctrine available?

from Connection
Column
getDoctrineColumn( string $table, string $column)

Get a Doctrine Schema Column instance.

from Connection
AbstractSchemaManager
getDoctrineSchemaManager()

Get the Doctrine DBAL schema manager for the connection.

from Connection
Connection
getDoctrineConnection()

Get the Doctrine DBAL database connection instance.

from Connection
PDO
getPdo()

Get the current PDO connection.

from Connection
PDO
getReadPdo()

Get the current PDO connection used for reading.

from Connection
$this
setPdo( PDO|null $pdo)

Set the PDO connection.

from Connection
$this
setReadPdo( PDO|null $pdo)

Set the PDO connection used for reading.

from Connection
$this
setReconnector( callable $reconnector)

Set the reconnect instance on the connection.

from Connection
string|null
getName()

Get the database connection name.

from Connection
mixed
getConfig( string $option)

Get an option from the configuration options.

from Connection
string
getDriverName()

Get the PDO driver name.

from Connection
Grammar
getQueryGrammar()

Get the query grammar used by the connection.

from Connection
void
setQueryGrammar( Grammar $grammar)

Set the query grammar used by the connection.

from Connection
Grammar
getSchemaGrammar()

Get the schema grammar used by the connection.

from Connection
void
setSchemaGrammar( Grammar $grammar)

Set the schema grammar used by the connection.

from Connection
Processor
getPostProcessor()

Get the query post processor used by the connection.

from Connection
void
setPostProcessor( Processor $processor)

Set the query post processor used by the connection.

from Connection
Dispatcher
getEventDispatcher()

Get the event dispatcher used by the connection.

from Connection
void
setEventDispatcher( Dispatcher $events)

Set the event dispatcher instance on the connection.

from Connection
bool
pretending()

Determine if the connection in a "dry run".

from Connection
int
getFetchMode()

Get the default fetch mode for the connection.

from Connection
mixed
getFetchArgument()

Get the fetch argument to be applied when selecting.

from Connection
array
getFetchConstructorArgument()

Get custom constructor arguments for the PDO::FETCH_CLASS fetch mode.

from Connection
int
setFetchMode( int $fetchMode, mixed $fetchArgument = null, array $fetchConstructorArgument = array())

Set the default fetch mode for the connection, and optional arguments for the given fetch mode.

from Connection
array
getQueryLog()

Get the connection query log.

from Connection
void
flushQueryLog()

Clear the query log.

from Connection
void
enableQueryLog()

Enable the query log on the connection.

from Connection
void
disableQueryLog()

Disable the query log on the connection.

from Connection
bool
logging()

Determine whether we're logging queries.

from Connection
string
getDatabaseName()

Get the name of the connected database.

from Connection
string
setDatabaseName( string $database)

Set the name of the connected database.

from Connection
string
getTablePrefix()

Get the table prefix for the connection.

from Connection
void
setTablePrefix( string $prefix)

Set the table prefix in use by the connection.

from Connection
Grammar
withTablePrefix( Grammar $grammar)

Set the table prefix and return the grammar.

from Connection

Details

in Connection at line line 160
void __construct( PDO|Closure $pdo, string $database = '', string $tablePrefix = '', array $config = array())

Create a new database connection instance.

Parameters

PDO|Closure $pdo
string $database
string $tablePrefix
array $config

Return Value

void

in Connection at line line 186
void useDefaultQueryGrammar()

Set the query grammar to the default implementation.

Return Value

void

in Connection at line line 206
void useDefaultSchemaGrammar()

Set the schema grammar to the default implementation.

Return Value

void

in Connection at line line 226
void useDefaultPostProcessor()

Set the query post processor to the default implementation.

Return Value

void

in Connection at line line 246
Builder getSchemaBuilder()

Get a schema builder instance for the connection.

Return Value

Builder

in Connection at line line 261
Builder table( string $table)

Begin a fluent query against a database table.

Parameters

string $table

Return Value

Builder

in Connection at line line 271
Builder query()

Get a new query builder instance.

Return Value

Builder

in Connection at line line 284
Expression raw( mixed $value)

Get a new raw query expression.

Parameters

mixed $value

Return Value

Expression

in Connection at line line 296
mixed selectOne( string $query, array $bindings = array())

Run a select statement and return a single result.

Parameters

string $query
array $bindings

Return Value

mixed

in Connection at line line 310
array selectFromWriteConnection( string $query, array $bindings = array())

Run a select statement against the database.

Parameters

string $query
array $bindings

Return Value

array

in Connection at line line 323
array select( string $query, array $bindings = array(), bool $useReadPdo = true)

Run a select statement against the database.

Parameters

string $query
array $bindings
bool $useReadPdo

Return Value

array

in Connection at line line 363
bool insert( string $query, array $bindings = array())

Run an insert statement against the database.

Parameters

string $query
array $bindings

Return Value

bool

in Connection at line line 375
int update( string $query, array $bindings = array())

Run an update statement against the database.

Parameters

string $query
array $bindings

Return Value

int

in Connection at line line 387
int delete( string $query, array $bindings = array())

Run a delete statement against the database.

Parameters

string $query
array $bindings

Return Value

int

in Connection at line line 399
bool statement( string $query, array $bindings = array())

Execute an SQL statement and return the boolean result.

Parameters

string $query
array $bindings

Return Value

bool

in Connection at line line 419
int affectingStatement( string $query, array $bindings = array())

Run an SQL statement and get the number of rows affected.

Parameters

string $query
array $bindings

Return Value

int

in Connection at line line 443
bool unprepared( string $query)

Run a raw, unprepared query against the PDO connection.

Parameters

string $query

Return Value

bool

in Connection at line line 460
array prepareBindings( array $bindings)

Prepare the query bindings for execution.

Parameters

array $bindings

Return Value

array

at line line 23
mixed transaction( Closure $callback)

Execute a Closure within a transaction.

Parameters

Closure $callback

Return Value

mixed

Exceptions

Throwable

in Connection at line line 520
void beginTransaction()

Start a new database transaction.

Return Value

void

in Connection at line line 540
void commit()

Commit the active database transaction.

Return Value

void

in Connection at line line 556
void rollBack()

Rollback the active database transaction.

Return Value

void

in Connection at line line 576
int transactionLevel()

Get the number of active transactions.

Return Value

int

in Connection at line line 587
array pretend( Closure $callback)

Execute the given callback in "dry run" mode.

Parameters

Closure $callback

Return Value

array

in Connection at line line 708
void disconnect()

Disconnect from the underlying PDO connection.

Return Value

void

in Connection at line line 720
void reconnect()

Reconnect to the database.

Return Value

void

Exceptions

LogicException

in Connection at line line 749
void logQuery( string $query, array $bindings, float|null $time = null)

Log a query in the connection's query log.

Parameters

string $query
array $bindings
float|null $time

Return Value

void

in Connection at line line 768
void listen( Closure $callback)

Register a database query listener with the connection.

Parameters

Closure $callback

Return Value

void

in Connection at line line 813
bool isDoctrineAvailable()

Is Doctrine available?

Return Value

bool

in Connection at line line 825
Column getDoctrineColumn( string $table, string $column)

Get a Doctrine Schema Column instance.

Parameters

string $table
string $column

Return Value

Column

in Connection at line line 837
AbstractSchemaManager getDoctrineSchemaManager()

Get the Doctrine DBAL schema manager for the connection.

Return Value

AbstractSchemaManager

in Connection at line line 847
Connection getDoctrineConnection()

Get the Doctrine DBAL database connection instance.

Return Value

Connection

in Connection at line line 865
PDO getPdo()

Get the current PDO connection.

Return Value

PDO

in Connection at line line 879
PDO getReadPdo()

Get the current PDO connection used for reading.

Return Value

PDO

in Connection at line line 896
$this setPdo( PDO|null $pdo)

Set the PDO connection.

Parameters

PDO|null $pdo

Return Value

$this

Exceptions

RuntimeException

in Connection at line line 913
$this setReadPdo( PDO|null $pdo)

Set the PDO connection used for reading.

Parameters

PDO|null $pdo

Return Value

$this

in Connection at line line 926
$this setReconnector( callable $reconnector)

Set the reconnect instance on the connection.

Parameters

callable $reconnector

Return Value

$this

in Connection at line line 938
string|null getName()

Get the database connection name.

Return Value

string|null

in Connection at line line 949
mixed getConfig( string $option)

Get an option from the configuration options.

Parameters

string $option

Return Value

mixed

in Connection at line line 959
string getDriverName()

Get the PDO driver name.

Return Value

string

in Connection at line line 969
Grammar getQueryGrammar()

Get the query grammar used by the connection.

Return Value

Grammar

in Connection at line line 980
void setQueryGrammar( Grammar $grammar)

Set the query grammar used by the connection.

Parameters

Grammar $grammar

Return Value

void

in Connection at line line 990
Grammar getSchemaGrammar()

Get the schema grammar used by the connection.

Return Value

Grammar

in Connection at line line 1001
void setSchemaGrammar( Grammar $grammar)

Set the schema grammar used by the connection.

Parameters

Grammar $grammar

Return Value

void

in Connection at line line 1011
Processor getPostProcessor()

Get the query post processor used by the connection.

Return Value

Processor

in Connection at line line 1022
void setPostProcessor( Processor $processor)

Set the query post processor used by the connection.

Parameters

Processor $processor

Return Value

void

in Connection at line line 1032
Dispatcher getEventDispatcher()

Get the event dispatcher used by the connection.

Return Value

Dispatcher

in Connection at line line 1043
void setEventDispatcher( Dispatcher $events)

Set the event dispatcher instance on the connection.

Parameters

Dispatcher $events

Return Value

void

in Connection at line line 1053
bool pretending()

Determine if the connection in a "dry run".

Return Value

bool

in Connection at line line 1063
int getFetchMode()

Get the default fetch mode for the connection.

Return Value

int

in Connection at line line 1073
mixed getFetchArgument()

Get the fetch argument to be applied when selecting.

Return Value

mixed

in Connection at line line 1083
array getFetchConstructorArgument()

Get custom constructor arguments for the PDO::FETCH_CLASS fetch mode.

Return Value

array

in Connection at line line 1096
int setFetchMode( int $fetchMode, mixed $fetchArgument = null, array $fetchConstructorArgument = array())

Set the default fetch mode for the connection, and optional arguments for the given fetch mode.

Parameters

int $fetchMode
mixed $fetchArgument
array $fetchConstructorArgument

Return Value

int

in Connection at line line 1108
array getQueryLog()

Get the connection query log.

Return Value

array

in Connection at line line 1118
void flushQueryLog()

Clear the query log.

Return Value

void

in Connection at line line 1128
void enableQueryLog()

Enable the query log on the connection.

Return Value

void

in Connection at line line 1138
void disableQueryLog()

Disable the query log on the connection.

Return Value

void

in Connection at line line 1148
bool logging()

Determine whether we're logging queries.

Return Value

bool

in Connection at line line 1158
string getDatabaseName()

Get the name of the connected database.

Return Value

string

in Connection at line line 1169
string setDatabaseName( string $database)

Set the name of the connected database.

Parameters

string $database

Return Value

string

in Connection at line line 1179
string getTablePrefix()

Get the table prefix for the connection.

Return Value

string

in Connection at line line 1190
void setTablePrefix( string $prefix)

Set the table prefix in use by the connection.

Parameters

string $prefix

Return Value

void

in Connection at line line 1203
Grammar withTablePrefix( Grammar $grammar)

Set the table prefix and return the grammar.

Parameters

Grammar $grammar

Return Value

Grammar