DocumentationExamplesTest
extends FunctionalTestCase
in package
Documentation examples to be parsed for inclusion in the MongoDB manual.
Tags
Table of Contents
- $manager : Manager
- $configuredFailPoints : array<string|int, mixed>
- assertMatchesDocument() : void
- Asserts that a document has expected values for some fields.
- assertSameDocument() : void
- Asserts that a document has expected values for all fields.
- assertSameDocuments() : void
- configureFailPoint() : void
- Configure a fail point for the test.
- createTestClient() : Client
- createTestManager() : Manager
- dataDescription() : string
- Compatibility method as PHPUnit 9 no longer includes this method.
- getUri() : string
- Return the connection URI.
- provideInvalidArrayValues() : mixed
- provideInvalidDocumentValues() : mixed
- setUp() : void
- tearDown() : void
- testAggregation_example_1() : void
- testAggregation_example_2() : void
- testAggregation_example_3() : void
- testAggregation_example_4() : void
- testCausalConsistency() : void
- testChangeStreamExample_1_4() : void
- testExample_14_19() : void
- testExample_1_2() : void
- testExample_20_28() : void
- testExample_29_37() : void
- testExample_3() : void
- testExample_38_41() : void
- testExample_42_50() : void
- testExample_51_54() : void
- testExample_55_58() : void
- testExample_6_13() : void
- testIndex_example_1() : void
- testIndex_example_2() : void
- testRunCommand_example_1() : void
- testRunCommand_example_2() : void
- testTransactions_intro_example_1() : void
- testTransactions_retry_example_3() : void
- testVersionedApi() : void
- testVersionedApiMigration() : void
- testWithTransactionExample() : void
- assertCollectionCount() : void
- assertCollectionDoesNotExist() : void
- Asserts that a collection with the given name does not exist on the server.
- assertCollectionExists() : void
- Asserts that a collection with the given name exists on the server.
- assertCommandSucceeded() : void
- assertDeprecated() : void
- assertSameObjectId() : void
- createCollection() : void
- Creates the test collection with the specified options.
- dropCollection() : void
- Drops the test collection with the specified options.
- getCollectionName() : string
- Return the test collection name.
- getDatabaseName() : string
- Return the test database name.
- getFeatureCompatibilityVersion() : mixed
- getInvalidArrayValues() : array<string|int, mixed>
- Return a list of invalid array values.
- getInvalidBooleanValues() : array<string|int, mixed>
- Return a list of invalid boolean values.
- getInvalidDocumentValues() : array<string|int, mixed>
- Return a list of invalid document values.
- getInvalidIntegerValues() : array<string|int, mixed>
- Return a list of invalid integer values.
- getInvalidReadConcernValues() : array<string|int, mixed>
- Return a list of invalid ReadPreference values.
- getInvalidReadPreferenceValues() : array<string|int, mixed>
- Return a list of invalid ReadPreference values.
- getInvalidSessionValues() : array<string|int, mixed>
- Return a list of invalid Session values.
- getInvalidStringValues() : array<string|int, mixed>
- Return a list of invalid string values.
- getInvalidWriteConcernValues() : array<string|int, mixed>
- Return a list of invalid WriteConcern values.
- getNamespace() : string
- Return the test namespace.
- getPrimaryServer() : mixed
- getServerStorageEngine() : mixed
- getServerVersion() : mixed
- isLoadBalanced() : mixed
- isMongos() : mixed
- isReplicaSet() : mixed
- isServerless() : bool
- Return whether serverless (i.e. proxy as mongos) is being utilized.
- isShardedCluster() : mixed
- isShardedClusterUsingReplicasets() : mixed
- skipIfCausalConsistencyIsNotSupported() : void
- skipIfChangeStreamIsNotSupported() : void
- skipIfClientSideEncryptionIsNotSupported() : void
- skipIfGeoHaystackIndexIsNotSupported() : void
- skipIfTransactionsAreNotSupported() : void
- wrapValuesForDataProvider() : array<string|int, mixed>
- Wrap a list of values for use as a single-argument data provider.
- appendAuthenticationOptions() : array<string|int, mixed>
- appendServerApiOption() : array<string|int, mixed>
- assertCursorCount() : void
- assertInventoryCount() : void
- commitWithRetry2() : void
- commitWithRetry3() : void
- disableFailPoints() : void
- Disables any fail points that were configured earlier in the test.
- doUpdateEmployeeInfo() : void
- getModuleInfo() : string|null
- isFailCommandEnabled() : bool
- Checks if the failCommand command is enabled by checking the enableTestCommands parameter
- isFailCommandSupported() : bool
- Checks if the failCommand command is supported on this server version
- normalizeBSON() : BSONDocument|BSONArray
- Normalizes a BSON document or array for use with assertEquals().
- runTransactionWithRetry1() : void
- runTransactionWithRetry3() : void
- updateEmployeeInfo1() : void
- updateEmployeeInfo3() : void
Properties
$manager
protected
Manager
$manager
$configuredFailPoints
private
array<string|int, mixed>
$configuredFailPoints
= []
Methods
assertMatchesDocument()
Asserts that a document has expected values for some fields.
public
assertMatchesDocument(array<string|int, mixed>|object $expectedDocument, array<string|int, mixed>|object $actualDocument) : void
Only fields in the expected document will be checked. The actual document may contain additional fields.
Parameters
- $expectedDocument : array<string|int, mixed>|object
- $actualDocument : array<string|int, mixed>|object
Return values
void —assertSameDocument()
Asserts that a document has expected values for all fields.
public
assertSameDocument(array<string|int, mixed>|object $expectedDocument, array<string|int, mixed>|object $actualDocument) : void
The actual document will be compared directly with the expected document and may not contain extra fields.
Parameters
- $expectedDocument : array<string|int, mixed>|object
- $actualDocument : array<string|int, mixed>|object
Return values
void —assertSameDocuments()
public
assertSameDocuments(array<string|int, mixed> $expectedDocuments, mixed $actualDocuments) : void
Parameters
- $expectedDocuments : array<string|int, mixed>
- $actualDocuments : mixed
Return values
void —configureFailPoint()
Configure a fail point for the test.
public
configureFailPoint(array<string|int, mixed>|stdClass $command[, Server|null $server = null ]) : void
The fail point will automatically be disabled during tearDown() to avoid affecting a subsequent test.
Parameters
- $command : array<string|int, mixed>|stdClass
-
configureFailPoint command document
- $server : Server|null = null
Tags
Return values
void —createTestClient()
public
static createTestClient([string|null $uri = null ][, array<string|int, mixed> $options = [] ][, array<string|int, mixed> $driverOptions = [] ]) : Client
Parameters
- $uri : string|null = null
- $options : array<string|int, mixed> = []
- $driverOptions : array<string|int, mixed> = []
Return values
Client —createTestManager()
public
static createTestManager([string|null $uri = null ][, array<string|int, mixed> $options = [] ][, array<string|int, mixed> $driverOptions = [] ]) : Manager
Parameters
- $uri : string|null = null
- $options : array<string|int, mixed> = []
- $driverOptions : array<string|int, mixed> = []
Return values
Manager —dataDescription()
Compatibility method as PHPUnit 9 no longer includes this method.
public
dataDescription() : string
Return values
string —getUri()
Return the connection URI.
public
static getUri() : string
Return values
string —provideInvalidArrayValues()
public
provideInvalidArrayValues() : mixed
Return values
mixed —provideInvalidDocumentValues()
public
provideInvalidDocumentValues() : mixed
Return values
mixed —setUp()
public
setUp() : void
Return values
void —tearDown()
public
tearDown() : void
Return values
void —testAggregation_example_1()
public
testAggregation_example_1() : void
Return values
void —testAggregation_example_2()
public
testAggregation_example_2() : void
Return values
void —testAggregation_example_3()
public
testAggregation_example_3() : void
Return values
void —testAggregation_example_4()
public
testAggregation_example_4() : void
Return values
void —testCausalConsistency()
public
testCausalConsistency() : void
Return values
void —testChangeStreamExample_1_4()
public
testChangeStreamExample_1_4() : void
Tags
Return values
void —testExample_14_19()
public
testExample_14_19() : void
Return values
void —testExample_1_2()
public
testExample_1_2() : void
Return values
void —testExample_20_28()
public
testExample_20_28() : void
Return values
void —testExample_29_37()
public
testExample_29_37() : void
Return values
void —testExample_3()
public
testExample_3() : void
Return values
void —testExample_38_41()
public
testExample_38_41() : void
Return values
void —testExample_42_50()
public
testExample_42_50() : void
Return values
void —testExample_51_54()
public
testExample_51_54() : void
Return values
void —testExample_55_58()
public
testExample_55_58() : void
Return values
void —testExample_6_13()
public
testExample_6_13() : void
Return values
void —testIndex_example_1()
public
testIndex_example_1() : void
Return values
void —testIndex_example_2()
public
testIndex_example_2() : void
Return values
void —testRunCommand_example_1()
public
testRunCommand_example_1() : void
Return values
void —testRunCommand_example_2()
public
testRunCommand_example_2() : void
Return values
void —testTransactions_intro_example_1()
public
testTransactions_intro_example_1() : void
Return values
void —testTransactions_retry_example_3()
public
testTransactions_retry_example_3() : void
Return values
void —testVersionedApi()
public
testVersionedApi() : void
Tags
Return values
void —testVersionedApiMigration()
public
testVersionedApiMigration() : void
Return values
void —testWithTransactionExample()
public
testWithTransactionExample() : void
Tags
Return values
void —assertCollectionCount()
protected
assertCollectionCount(mixed $namespace, mixed $count) : void
Parameters
- $namespace : mixed
- $count : mixed
Return values
void —assertCollectionDoesNotExist()
Asserts that a collection with the given name does not exist on the server.
protected
assertCollectionDoesNotExist(string $collectionName[, string|null $databaseName = null ]) : void
$databaseName defaults to TestCase::getDatabaseName() if unspecified.
Parameters
- $collectionName : string
- $databaseName : string|null = null
Return values
void —assertCollectionExists()
Asserts that a collection with the given name exists on the server.
protected
assertCollectionExists(string $collectionName[, string|null $databaseName = null ][, callable|null $callback = null ]) : void
$databaseName defaults to TestCase::getDatabaseName() if unspecified. An optional $callback may be provided, which should take a CollectionInfo argument as its first and only parameter. If a CollectionInfo matching the given name is found, it will be passed to the callback, which may perform additional assertions.
Parameters
- $collectionName : string
- $databaseName : string|null = null
- $callback : callable|null = null
Return values
void —assertCommandSucceeded()
protected
assertCommandSucceeded(mixed $document) : void
Parameters
- $document : mixed
Return values
void —assertDeprecated()
protected
assertDeprecated(callable $execution) : void
Parameters
- $execution : callable
Return values
void —assertSameObjectId()
protected
assertSameObjectId(mixed $expectedObjectId, mixed $actualObjectId) : void
Parameters
- $expectedObjectId : mixed
- $actualObjectId : mixed
Return values
void —createCollection()
Creates the test collection with the specified options.
protected
createCollection([array<string|int, mixed> $options = [] ]) : void
If the "writeConcern" option is not specified but is supported by the server, a majority write concern will be used. This is helpful for tests using transactions or secondary reads.
Parameters
- $options : array<string|int, mixed> = []
Return values
void —dropCollection()
Drops the test collection with the specified options.
protected
dropCollection([array<string|int, mixed> $options = [] ]) : void
If the "writeConcern" option is not specified but is supported by the server, a majority write concern will be used. This is helpful for tests using transactions or secondary reads.
Parameters
- $options : array<string|int, mixed> = []
Return values
void —getCollectionName()
Return the test collection name.
protected
getCollectionName() : string
Return values
string —getDatabaseName()
Return the test database name.
protected
getDatabaseName() : string
Return values
string —getFeatureCompatibilityVersion()
protected
getFeatureCompatibilityVersion([ReadPreference|null $readPreference = null ]) : mixed
Parameters
- $readPreference : ReadPreference|null = null
Return values
mixed —getInvalidArrayValues()
Return a list of invalid array values.
protected
getInvalidArrayValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidBooleanValues()
Return a list of invalid boolean values.
protected
getInvalidBooleanValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidDocumentValues()
Return a list of invalid document values.
protected
getInvalidDocumentValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidIntegerValues()
Return a list of invalid integer values.
protected
getInvalidIntegerValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidReadConcernValues()
Return a list of invalid ReadPreference values.
protected
getInvalidReadConcernValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidReadPreferenceValues()
Return a list of invalid ReadPreference values.
protected
getInvalidReadPreferenceValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidSessionValues()
Return a list of invalid Session values.
protected
getInvalidSessionValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidStringValues()
Return a list of invalid string values.
protected
getInvalidStringValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getInvalidWriteConcernValues()
Return a list of invalid WriteConcern values.
protected
getInvalidWriteConcernValues([bool $includeNull = false ]) : array<string|int, mixed>
Parameters
- $includeNull : bool = false
Return values
array<string|int, mixed> —getNamespace()
Return the test namespace.
protected
getNamespace() : string
Return values
string —getPrimaryServer()
protected
getPrimaryServer() : mixed
Return values
mixed —getServerStorageEngine()
protected
getServerStorageEngine([ReadPreference|null $readPreference = null ]) : mixed
Parameters
- $readPreference : ReadPreference|null = null
Return values
mixed —getServerVersion()
protected
getServerVersion([ReadPreference|null $readPreference = null ]) : mixed
Parameters
- $readPreference : ReadPreference|null = null
Return values
mixed —isLoadBalanced()
protected
isLoadBalanced() : mixed
Return values
mixed —isMongos()
protected
isMongos() : mixed
Return values
mixed —isReplicaSet()
protected
isReplicaSet() : mixed
Return values
mixed —isServerless()
Return whether serverless (i.e. proxy as mongos) is being utilized.
protected
static isServerless() : bool
Return values
bool —isShardedCluster()
protected
isShardedCluster() : mixed
Return values
mixed —isShardedClusterUsingReplicasets()
protected
isShardedClusterUsingReplicasets() : mixed
Return values
mixed —skipIfCausalConsistencyIsNotSupported()
protected
skipIfCausalConsistencyIsNotSupported() : void
Return values
void —skipIfChangeStreamIsNotSupported()
protected
skipIfChangeStreamIsNotSupported() : void
Return values
void —skipIfClientSideEncryptionIsNotSupported()
protected
skipIfClientSideEncryptionIsNotSupported() : void
Return values
void —skipIfGeoHaystackIndexIsNotSupported()
protected
skipIfGeoHaystackIndexIsNotSupported() : void
Return values
void —skipIfTransactionsAreNotSupported()
protected
skipIfTransactionsAreNotSupported() : void
Return values
void —wrapValuesForDataProvider()
Wrap a list of values for use as a single-argument data provider.
protected
wrapValuesForDataProvider(array<string|int, mixed> $values) : array<string|int, mixed>
Parameters
- $values : array<string|int, mixed>
-
List of values
Return values
array<string|int, mixed> —appendAuthenticationOptions()
private
static appendAuthenticationOptions(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
Return values
array<string|int, mixed> —appendServerApiOption()
private
static appendServerApiOption(array<string|int, mixed> $driverOptions) : array<string|int, mixed>
Parameters
- $driverOptions : array<string|int, mixed>
Return values
array<string|int, mixed> —assertCursorCount()
private
assertCursorCount(mixed $count, Cursor $cursor) : void
Parameters
- $count : mixed
- $cursor : Cursor
Return values
void —assertInventoryCount()
private
assertInventoryCount(mixed $count) : void
Parameters
- $count : mixed
Return values
void —commitWithRetry2()
private
commitWithRetry2(Session $session) : void
Parameters
- $session : Session
Return values
void —commitWithRetry3()
private
commitWithRetry3(Session $session) : void
Parameters
- $session : Session
Return values
void —disableFailPoints()
Disables any fail points that were configured earlier in the test.
private
disableFailPoints() : void
This tracks fail points set via configureFailPoint() and should be called during tearDown().
Return values
void —doUpdateEmployeeInfo()
private
doUpdateEmployeeInfo(Client $client) : void
Parameters
- $client : Client
Return values
void —getModuleInfo()
private
getModuleInfo(string $row) : string|null
Parameters
- $row : string
Return values
string|null —isFailCommandEnabled()
Checks if the failCommand command is enabled by checking the enableTestCommands parameter
private
isFailCommandEnabled() : bool
Return values
bool —isFailCommandSupported()
Checks if the failCommand command is supported on this server version
private
isFailCommandSupported() : bool
Return values
bool —normalizeBSON()
Normalizes a BSON document or array for use with assertEquals().
private
normalizeBSON(array<string|int, mixed>|object $bson) : BSONDocument|BSONArray
The argument will be converted to a BSONArray or BSONDocument based on its type and keys. Document fields will be sorted alphabetically. Each value within the array or document will then be normalized recursively.
Parameters
- $bson : array<string|int, mixed>|object
Tags
Return values
BSONDocument|BSONArray —runTransactionWithRetry1()
private
runTransactionWithRetry1(callable $txnFunc, Client $client, Session $session) : void
Parameters
- $txnFunc : callable
- $client : Client
- $session : Session
Return values
void —runTransactionWithRetry3()
private
runTransactionWithRetry3(callable $txnFunc, Client $client, Session $session) : void
Parameters
- $txnFunc : callable
- $client : Client
- $session : Session
Return values
void —updateEmployeeInfo1()
private
updateEmployeeInfo1(Client $client, Session $session) : void
Parameters
- $client : Client
- $session : Session
Return values
void —updateEmployeeInfo3()
private
updateEmployeeInfo3(Client $client, Session $session) : void
Parameters
- $client : Client
- $session : Session