MediaWiki  1.34.0
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Wikimedia\Rdbms\DatabaseDomain Class Reference

Class to handle database/schema/prefix specifications for IDatabase. More...

Public Member Functions

 __construct ( $database, $schema, $prefix)
 
 __toString ()
 
 equals ( $other)
 
 getDatabase ()
 
 getId ()
 
 getSchema ()
 
 getTablePrefix ()
 
 isCompatible ( $other)
 Check whether the domain $other meets the specifications of this domain. More...
 
 isUnspecified ()
 

Static Public Member Functions

static newFromId ( $domain)
 
static newUnspecified ()
 

Private Member Functions

 convertToString ()
 

Static Private Member Functions

static decode ( $encoded)
 
static encode ( $decoded)
 

Private Attributes

string null $database
 
string $equivalentString
 Cache of convertToString() More...
 
string $prefix
 
string null $schema
 

Detailed Description

Class to handle database/schema/prefix specifications for IDatabase.

The components of a database domain are defined as follows:

  • database: name of a server-side collection of schemas that is client-selectable
  • schema: name of a server-side collection of tables within the given database
  • prefix: table name prefix of an application-defined table collection

If an RDBMS does not support server-side collections of table collections (schemas) then the schema component should be null and the "database" component treated as a collection of exactly one table collection (the implied schema for that "database").

The above criteria should determine how components should map to RDBMS specific keywords rather than "database"/"schema" always mapping to "DATABASE"/"SCHEMA" as used by the RDBMS.

Definition at line 40 of file DatabaseDomain.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabaseDomain::__construct (   $database,
  $schema,
  $prefix 
)
Parameters
string | null$databaseDatabase name
string | null$schemaSchema name
string$prefixTable prefix

Definition at line 56 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database, Wikimedia\Rdbms\DatabaseDomain\$prefix, and Wikimedia\Rdbms\DatabaseDomain\$schema.

Member Function Documentation

◆ __toString()

Wikimedia\Rdbms\DatabaseDomain::__toString ( )
Returns
string

Definition at line 270 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\getId().

◆ convertToString()

Wikimedia\Rdbms\DatabaseDomain::convertToString ( )
private
Returns
string

Definition at line 207 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$prefix, and Wikimedia\Rdbms\DatabaseDomain\$schema.

Referenced by Wikimedia\Rdbms\DatabaseDomain\getId().

◆ decode()

static Wikimedia\Rdbms\DatabaseDomain::decode (   $encoded)
staticprivate

Definition at line 242 of file DatabaseDomain.php.

◆ encode()

static Wikimedia\Rdbms\DatabaseDomain::encode (   $decoded)
staticprivate

Definition at line 224 of file DatabaseDomain.php.

◆ equals()

Wikimedia\Rdbms\DatabaseDomain::equals (   $other)
Parameters
DatabaseDomain | string$other
Returns
bool Whether the domain instances are the same by value

Definition at line 122 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\getId().

◆ getDatabase()

Wikimedia\Rdbms\DatabaseDomain::getDatabase ( )
Returns
string|null Database name

Definition at line 175 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database.

Referenced by Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\doSelectDomain(), Wikimedia\Rdbms\LoadBalancer\isMasterRunningReadOnly(), Wikimedia\Rdbms\LoadBalancer\reallyOpenConnection(), and Wikimedia\Rdbms\LoadBalancer\setLocalDomain().

◆ getId()

Wikimedia\Rdbms\DatabaseDomain::getId ( )
Returns
string

Definition at line 196 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$equivalentString, and Wikimedia\Rdbms\DatabaseDomain\convertToString().

Referenced by Wikimedia\Rdbms\DatabaseDomain\__toString(), Wikimedia\Rdbms\DatabaseDomain\equals(), Wikimedia\Rdbms\DBConnRef\getDomainID(), and Wikimedia\Rdbms\LoadBalancer\isMasterRunningReadOnly().

◆ getSchema()

Wikimedia\Rdbms\DatabaseDomain::getSchema ( )
Returns
string|null Database schema

Definition at line 182 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$schema.

Referenced by Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\doSelectDomain(), Wikimedia\Rdbms\LoadBalancer\isMasterRunningReadOnly(), and Wikimedia\Rdbms\LoadBalancer\reallyOpenConnection().

◆ getTablePrefix()

Wikimedia\Rdbms\DatabaseDomain::getTablePrefix ( )
Returns
string Table prefix

Definition at line 189 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$prefix.

Referenced by Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\doSelectDomain(), and Wikimedia\Rdbms\LoadBalancer\reallyOpenConnection().

◆ isCompatible()

Wikimedia\Rdbms\DatabaseDomain::isCompatible (   $other)

Check whether the domain $other meets the specifications of this domain.

If this instance has a null database specifier, then $other can have any database specifier, including null. This is likewise true if the schema specifier is null. This is not transitive like equals() since a domain that explicitly wants a certain database or schema cannot be satisfied by one of another (nor null). If the prefix is empty and the DB and schema are both null, then the entire domain is considered unspecified, and any prefix of $other is considered compatible.

Parameters
DatabaseDomain | string$other
Returns
bool
Since
1.32

Definition at line 148 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\isUnspecified(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

◆ isUnspecified()

Wikimedia\Rdbms\DatabaseDomain::isUnspecified ( )
Returns
bool
Since
1.32

Definition at line 166 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\isCompatible().

◆ newFromId()

static Wikimedia\Rdbms\DatabaseDomain::newFromId (   $domain)
static
Parameters
DatabaseDomain | string$domainResult of DatabaseDomain::toString()
Returns
DatabaseDomain

Definition at line 77 of file DatabaseDomain.php.

References Wikimedia\Rdbms\DatabaseDomain\$database, Wikimedia\Rdbms\DatabaseDomain\$prefix, and Wikimedia\Rdbms\DatabaseDomain\$schema.

Referenced by Wikimedia\Rdbms\LBFactory\__construct(), Wikimedia\Rdbms\LoadBalancer\__construct(), Wikimedia\Rdbms\DBConnRef\dbSchema(), Wikimedia\Rdbms\DBConnRef\getDBname(), Wikimedia\Rdbms\LBFactoryMulti\getDomainDatabase(), Wikimedia\Rdbms\LoadBalancer\getForeignConnection(), Wikimedia\Rdbms\LoadBalancer\getReadOnlyReason(), Wikimedia\Rdbms\DatabaseDomain\isCompatible(), Wikimedia\Rdbms\LBFactory\redefineLocalDomain(), Wikimedia\Rdbms\LoadBalancer\redefineLocalDomain(), Wikimedia\Rdbms\Database\selectDomain(), and Wikimedia\Rdbms\DBConnRef\tablePrefix().

◆ newUnspecified()

static Wikimedia\Rdbms\DatabaseDomain::newUnspecified ( )
static
Returns
DatabaseDomain

Definition at line 114 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\LBFactory\__construct(), and Wikimedia\Rdbms\LoadBalancer\__construct().

Member Data Documentation

◆ $database

string null Wikimedia\Rdbms\DatabaseDomain::$database
private

Definition at line 42 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\__construct(), Wikimedia\Rdbms\DatabaseDomain\getDatabase(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

◆ $equivalentString

string Wikimedia\Rdbms\DatabaseDomain::$equivalentString
private

Cache of convertToString()

Definition at line 49 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\getId().

◆ $prefix

string Wikimedia\Rdbms\DatabaseDomain::$prefix
private

Definition at line 46 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\__construct(), Wikimedia\Rdbms\DatabaseDomain\convertToString(), Wikimedia\Rdbms\DatabaseDomain\getTablePrefix(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

◆ $schema

string null Wikimedia\Rdbms\DatabaseDomain::$schema
private

Definition at line 44 of file DatabaseDomain.php.

Referenced by Wikimedia\Rdbms\DatabaseDomain\__construct(), Wikimedia\Rdbms\DatabaseDomain\convertToString(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

The documentation for this class was generated from the following file: