Skip to content

Add vector search type to atlas search indexes #2817

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

Closed
wants to merge 1 commit into from
Closed

Add vector search type to atlas search indexes #2817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions doctrine-mongo-mapping.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,12 +566,20 @@
</xs:choice>

<xs:attribute name="name" type="xs:string" />
<xs:attribute name="type" type="odm:search-index-type" />
<xs:attribute name="dynamic" type="xs:boolean" />
<xs:attribute name="analyzer" type="xs:string" />
<xs:attribute name="searchAnalyzer" type="xs:string" />
<xs:attribute name="storedSource" type="xs:boolean" />
</xs:complexType>

<xs:simpleType name="search-index-type">
<xs:restriction base="xs:string">
<xs:enumeration value="search" />
<xs:enumeration value="vectorSearch" />
</xs:restriction>
</xs:simpleType>

<!-- https://www.mongodb.com/docs/atlas/atlas-search/define-field-mappings/ -->
<xs:complexType name="search-index-field">
<xs:choice minOccurs="0" maxOccurs="unbounded">
Expand Down
2 changes: 2 additions & 0 deletions lib/Doctrine/ODM/MongoDB/Mapping/Annotations/SearchIndex.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class SearchIndex implements Annotation
* @param list<array>|null $analyzers
* @param SearchIndexStoredSource|null $storedSource
* @param list<SearchIndexSynonym>|null $synonyms
* @param string|null $type Type of index: 'search' (default) or 'vectorSearch'
*/
public function __construct(
public ?string $name = null,
Expand All @@ -34,6 +35,7 @@ public function __construct(
public ?array $analyzers = null,
public $storedSource = null,
public ?array $synonyms = null,
public ?string $type = null,
) {
}
}
3 changes: 2 additions & 1 deletion lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1245,7 +1245,7 @@
*
* @phpstan-param SearchIndexDefinition $definition
*/
public function addSearchIndex(array $definition, ?string $name = null): void
public function addSearchIndex(array $definition, ?string $name = null, ?string $type): void

Check failure on line 1248 in lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

View workflow job for this annotation

GitHub Actions / Static Analysis with PHPStan (8.4) 

Deprecated in PHP 8.1: Required parameter $type follows optional parameter $name.
{
$name ??= self::DEFAULT_SEARCH_INDEX_NAME;

Expand All @@ -1256,6 +1256,7 @@
$this->searchIndexes[] = [
'definition' => $definition,
'name' => $name,
'type' => $type,
];
}

Expand Down
2 changes: 1 addition & 1 deletion lib/Doctrine/ODM/MongoDB/Mapping/Driver/AttributeDriver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ private function addSearchIndex(ClassMetadata $class, SearchIndex $index): void
}
}

$class->addSearchIndex($definition, $index->name ?? null);
$class->addSearchIndex($definition, $index->name, $index->type);
}

/**
Expand Down
Loading