Specify time series options when creating collection

doctrine · Oct 10, 2024 · 80c47e3 · 80c47e3
1 parent ccb9ecd
commit 80c47e3
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 0 deletions.
diff --git a/lib/Doctrine/ODM/MongoDB/SchemaManager.php b/lib/Doctrine/ODM/MongoDB/SchemaManager.php
@@ -621,6 +621,20 @@ public function createDocumentCollection(string $documentName, ?int $maxTimeMs =
  $options['validationLevel'] = $class->getValidationLevel();
  }
 
+ if ($class->isTimeSeries) {
+ $options['timeseries'] = array_filter(
+ [
+ 'timeField' => $class->timeSeriesOptions->timeField,
+ 'metaField' => $class->timeSeriesOptions->metaField,
+ 'granularity' => $class->timeSeriesOptions->granularity?->value,
+ ],
+ );
+
+ if ($class->timeSeriesOptions->expireAfterSeconds) {
+ $options['expireAfterSeconds'] = $class->timeSeriesOptions->expireAfterSeconds;
+ }
+ }
+
  $this->dm->getDocumentDatabase($documentName)->createCollection(
  $class->getCollection(),
  $this->getWriteOptions($maxTimeMs, $writeConcern, $options),

diff --git a/tests/Doctrine/ODM/MongoDB/Tests/SchemaManagerTest.php b/tests/Doctrine/ODM/MongoDB/Tests/SchemaManagerTest.php
@@ -20,6 +20,7 @@
 use Documents\Sharded\ShardedOne;
 use Documents\Sharded\ShardedOneWithDifferentKey;
 use Documents\SimpleReferenceUser;
+use Documents\TimeSeries\TimeSeriesDocument;
 use Documents\Tournament\Tournament;
 use Documents\UserName;
 use InvalidArgumentException;
@@ -760,6 +761,33 @@ public function testCreateView(array $expectedWriteOptions, ?int $maxTimeMs, ?Wr
  $this->schemaManager->createDocumentCollection(UserName::class, $maxTimeMs, $writeConcern);
  }
 
+ /** @psalm-param IndexOptions $expectedWriteOptions */
+ #[DataProvider('getWriteOptions')]
+ public function testCreateTimeSeriesCollection(array $expectedWriteOptions, ?int $maxTimeMs, ?WriteConcern $writeConcern): void
+ {
+ $metadata = $this->dm->getClassMetadata(TimeSeriesDocument::class);
+
+ $options = [
+ 'timeseries' => [
+ 'timeField' => 'time',
+ 'metaField' => 'metadata',
+ 'granularity' => 'seconds',
+ ],
+ 'expireAfterSeconds' => 86400,
+ ];
+
+ $database = $this->documentDatabases[$this->getDatabaseName($metadata)];
+ $database
+ ->expects($this->once())
+ ->method('createCollection')
+ ->with(
+ 'TimeSeriesDocument',
+ $this->writeOptions($options + $expectedWriteOptions),
+ );
+
+ $this->schemaManager->createDocumentCollection(TimeSeriesDocument::class, $maxTimeMs, $writeConcern);
+ }
+
  /** @psalm-param IndexOptions $expectedWriteOptions */
  #[DataProvider('getWriteOptions')]
  public function testCreateCollections(array $expectedWriteOptions, ?int $maxTimeMs, ?WriteConcern $writeConcern): void

diff --git a/tests/Documents/TimeSeries/TimeSeriesDocument.php b/tests/Documents/TimeSeries/TimeSeriesDocument.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Documents\TimeSeries;
+
+use DateTime;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Mapping\TimeSeries\Granularity;
+
+#[ODM\Document]
+#[ODM\TimeSeries('time', 'metadata', Granularity::Seconds, 86400)]
+class TimeSeriesDocument
+{
+ #[ODM\Id]
+ public ?string $id;
+
+ #[ODM\Field]
+ public DateTime $time;
+
+ #[ODM\Field]
+ public string $metadata;
+
+ #[ODM\Field]
+ public int $value;
+}