SQLAzureShardManager
in package
implements
ShardManager
Sharding using the SQL Azure Federations support.
Tags
Interfaces, Classes and Traits
- ShardManager
- Sharding Manager gives access to APIs to implementing sharding on top of Doctrine\DBAL\Connection instances.
Table of Contents
- $conn : Connection
- $currentDistributionValue : string
- $distributionKey : string
- $distributionType : string
- $federationName : string
- $filteringEnabled : bool
- __construct() : mixed
- getCurrentDistributionValue() : string
- Gets the distribution value currently used for sharding.
- getDistributionKey() : string
- Gets the distribution key.
- getDistributionType() : string
- Gets the Doctrine Type name used for the distribution.
- getFederationName() : string
- Gets the name of the federation.
- getShards() : array<string|int, mixed>
- Gets information about the amount of shards and other details.
- queryAll() : array<string|int, mixed>
- Queries all shards in undefined order and return the results appended to each other. Restore the previous distribution value after execution.
- selectGlobal() : void
- Selects global database with global data.
- selectShard() : void
- Selects the shard against which the queries after this statement will be issued.
- setFilteringEnabled() : void
- Sets Enabled/Disable filtering on the fly.
- splitFederation() : void
- Splits Federation at a given distribution value.
Properties
$conn
private
Connection
$conn
$currentDistributionValue
private
string
$currentDistributionValue
$distributionKey
private
string
$distributionKey
$distributionType
private
string
$distributionType
$federationName
private
string
$federationName
$filteringEnabled
private
bool
$filteringEnabled
Methods
__construct()
public
__construct(Connection $conn) : mixed
Parameters
- $conn : Connection
Tags
Return values
mixed —getCurrentDistributionValue()
Gets the distribution value currently used for sharding.
public
getCurrentDistributionValue() : string
Return values
string —getDistributionKey()
Gets the distribution key.
public
getDistributionKey() : string
Return values
string —getDistributionType()
Gets the Doctrine Type name used for the distribution.
public
getDistributionType() : string
Return values
string —getFederationName()
Gets the name of the federation.
public
getFederationName() : string
Return values
string —getShards()
Gets information about the amount of shards and other details.
public
getShards() : array<string|int, mixed>
Return values
array<string|int, mixed> —queryAll()
Queries all shards in undefined order and return the results appended to each other. Restore the previous distribution value after execution.
public
queryAll(mixed $sql[, array<string|int, mixed> $params = array() ][, array<string|int, mixed> $types = array() ]) : array<string|int, mixed>
Parameters
- $sql : mixed
- $params : array<string|int, mixed> = array()
- $types : array<string|int, mixed> = array()
Return values
array<string|int, mixed> —selectGlobal()
Selects global database with global data.
public
selectGlobal() : void
Return values
void —selectShard()
Selects the shard against which the queries after this statement will be issued.
public
selectShard(mixed $distributionValue) : void
Parameters
- $distributionValue : mixed
Return values
void —setFilteringEnabled()
Sets Enabled/Disable filtering on the fly.
public
setFilteringEnabled(bool $flag) : void
Parameters
- $flag : bool
Return values
void —splitFederation()
Splits Federation at a given distribution value.
public
splitFederation(mixed $splitDistributionValue) : void
Parameters
- $splitDistributionValue : mixed