Skip to content

Use getDatabase and getCollection #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2025
Merged

Use getDatabase and getCollection #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2fcf0b
Use `getDatabase` and `getCollection`
OskarStark Mar 3, 2025
124bbaa
Merge branch '0.3' into feature/remove-deprecations
GromNaN Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ class MyService
## Database Usage

The client service provides access to databases and collections. You can access a database by calling the
`selectDatabase` method, passing the database name and potential options:
`getDatabase` method, passing the database name and potential options:

```php
use MongoDB\Client;
Expand All @@ -144,7 +144,7 @@ class MyService
public function __construct(
Client $client,
) {
$this->database = $client->selectDatabase('myDatabase');
$this->database = $client->getDatabase('myDatabase');
}
}
```
Expand Down Expand Up @@ -185,7 +185,7 @@ class MyService

## Collection Usage

To inject a collection, you can either call the `selectCollection` method on a `Client` or `Database` instance.
To inject a collection, you can either call the `getCollection` method on a `Client` or `Database` instance.
For convenience, the `#[AutowireCollection]` attribute provides a quicker alternative:

```php
Expand Down
2 changes: 1 addition & 1 deletion src/Attribute/AutowireCollection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public function __construct(
: MongoDBExtension::createClientServiceId($client);

parent::__construct(
callable: [new Reference($this->serviceId), 'selectCollection'],
callable: [new Reference($this->serviceId), 'getCollection'],
lazy: $lazy,
);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Attribute/AutowireDatabase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public function __construct(
: MongoDBExtension::createClientServiceId($client);

parent::__construct(
callable: [new Reference($this->serviceId), 'selectDatabase'],
callable: [new Reference($this->serviceId), 'getDatabase'],
lazy: $lazy,
);
}
Expand Down
2 changes: 1 addition & 1 deletion tests/Functional/DataCollector/DriverEventSubscriberTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function collectCommandEvent(int $clientId, string $requestId, array $dat

public function testCommandSucceeded(): void
{
$this->getClient()->selectCollection('database1', 'collection1')->find();
$this->getClient()->getCollection('database1', 'collection1')->find();

// The 2 events are commandStarted and commandSucceeded
$this->assertCount(2, $this->collector->events);
Expand Down
6 changes: 3 additions & 3 deletions tests/Functional/FunctionalTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ public function assertNumberOfDocuments(int $expected, string $clientId, string
{
$client = self::getContainer()->get(MongoDBExtension::createClientServiceId($clientId));
assert($client instanceof Client);
$db = $client->selectDatabase($database);
$db = $client->getDatabase($database);
assert($db instanceof Database);
$collection = $db->selectCollection($collection);
$collection = $db->getCollection($collection);
assert($collection instanceof Collection);

$this->assertSame($expected, $collection->countDocuments());
Expand All @@ -80,7 +80,7 @@ private function dropDatabase(string $clientId, string $database): void
{
$client = self::getContainer()->get(MongoDBExtension::createClientServiceId($clientId));
assert($client instanceof Client);
$db = $client->selectDatabase($database);
$db = $client->getDatabase($database);
assert($db instanceof Database);
$db->drop();
}
Expand Down
6 changes: 3 additions & 3 deletions tests/TestApplication/src/Controller/AbstractMongoDBController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@ final public function insertDocumentForClient(Client|string $client, ?string $da

assert($database !== null);

$db = $client->selectDatabase($database);
$db = $client->getDatabase($database);
$db->drop();

if (! $collection instanceof Collection) {
$collection = $db->selectCollection($collection);
$collection = $db->getCollection($collection);
}

$collection->insertOne(['foo' => 'bar']);
Expand All @@ -80,7 +80,7 @@ final public function insertDocumentForClient(Client|string $client, ?string $da
final public function insertDocumentForDatabase(Database $database, string $collection): void
{
$database->drop();
$collection = $database->selectCollection($collection);
$collection = $database->getCollection($collection);
$collection->insertOne(['foo' => 'bar']);
}

Expand Down
6 changes: 3 additions & 3 deletions tests/Unit/Attribute/AutowireCollectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public function testMinimal(): void
{
$autowire = new AutowireCollection();

$this->assertEquals([new Reference($client = Client::class), 'selectCollection'], $autowire->value);
$this->assertEquals([new Reference($client = Client::class), 'getCollection'], $autowire->value);

$definition = $autowire->buildDefinition(
value: $autowire->value,
Expand All @@ -62,7 +62,7 @@ public function testCollection(): void
client: 'default',
);

$this->assertEquals([new Reference('mongodb.client.default'), 'selectCollection'], $autowire->value);
$this->assertEquals([new Reference('mongodb.client.default'), 'getCollection'], $autowire->value);

$definition = $autowire->buildDefinition(
value: $autowire->value,
Expand All @@ -88,7 +88,7 @@ public function testWithoutCollection(): void
client: 'default',
);

$this->assertEquals([new Reference('mongodb.client.default'), 'selectCollection'], $autowire->value);
$this->assertEquals([new Reference('mongodb.client.default'), 'getCollection'], $autowire->value);

$definition = $autowire->buildDefinition(
value: $autowire->value,
Expand Down
6 changes: 3 additions & 3 deletions tests/Unit/Attribute/AutowireDatabaseTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function testMinimal(): void
{
$autowire = new AutowireDatabase();

$this->assertEquals([new Reference(Client::class), 'selectDatabase'], $autowire->value);
$this->assertEquals([new Reference(Client::class), 'getDatabase'], $autowire->value);

$definition = $autowire->buildDefinition(
value: $autowire->value,
Expand All @@ -58,7 +58,7 @@ public function testDatabase(): void
client: 'default',
);

$this->assertEquals([new Reference('mongodb.client.default'), 'selectDatabase'], $autowire->value);
$this->assertEquals([new Reference('mongodb.client.default'), 'getDatabase'], $autowire->value);

$definition = $autowire->buildDefinition(
value: $autowire->value,
Expand All @@ -82,7 +82,7 @@ public function testWithoutDatabase(): void
client: 'default',
);

$this->assertEquals([new Reference('mongodb.client.default'), 'selectDatabase'], $autowire->value);
$this->assertEquals([new Reference('mongodb.client.default'), 'getDatabase'], $autowire->value);

$definition = $autowire->buildDefinition(
value: $autowire->value,
Expand Down