Skip to main content

Migrate from OpenSearch to Zilliz Cloud

This topic describes how Zilliz Cloud handles data type mapping, collection naming rules, and considerations when migrating from OpenSearch.

Prerequisites

Before starting your OpenSearch to Zilliz Cloud migration, ensure you meet these requirements:

OpenSearch requirements

RequirementDetails
Network accessSource OpenSearch cluster must be accessible from the public internet
AuthenticationValid cluster endpoint, username, and password with necessary permissions
Vector field requirementEach source index must contain at least one k-NN vector field
Data availabilitySource indexes must contain data. Empty indexes cannot be migrated.

Zilliz Cloud requirements

RequirementDetails
User roleOrganization Owner or Project Admin
Cluster capacitySufficient storage and compute resources (use the CU calculator to estimate CU size)
Network accessAdd Zilliz Cloud IPs to allowlists if using network restrictions

Data type mapping

The following table summarizes how field types in OpenSearch are mapped to Zilliz Cloud field types, along with details on any customization options.

OpenSearch Field TypeZilliz Cloud Field TypeDescription
Primary keyPrimary keyOpenSearch's primary key (_id) is automatically mapped as the primary key in Zilliz Cloud.
When migrating data, you can enable Auto ID. However, if you do so, the original primary key values from your source table will be discarded.
k-NN vectorFLOAT_VECTORThe float vector type from OpenSearch is mapped to FLOAT_VECTOR on Zilliz Cloud. Byte/Binary vectors from OpenSearch are not supported for migration.
Vector dimensions remain unchanged.
AliasNot supportedAlias fields are not supported.
BinaryVARCHARBinary data is stored as a string on Zilliz Cloud.
Numeric
byteINT8Directly mapped.
doubleDOUBLEDirectly mapped.
floatFLOATDirectly mapped.
half_floatFLOATMapped to FLOAT.
integerINT32Directly mapped.
longINT64Directly mapped.
shortINT16Directly mapped.
unsigned_longNot supportedNot supported on Zilliz Cloud.
scaled_floatNot supportedNot supported on Zilliz Cloud.
BooleanBOOLStores true or false.
DateVARCHARStored as a string. Ensure correct format conversion.
IP addressVARCHARStored as a string.
RangeJSONStored in JSON format.
Object
objectJSONStored in JSON format.
nestedJSONStored in JSON format.
flat_objectJSONStored in JSON format.
joinVARCHARStored as a string.
String
keywordVARCHARStored as a string.
textVARCHARMapped to VARCHAR .
match_only_textVARCHARStored as a string.
token_countINT32Stored as INT32.
wildcardNot supportedNot supported on Zilliz Cloud.
AutocompleteVARCHARStored as a string.
GeographicVARCHARStored as a string.
RankVARCHARStored as a string.
PercolatorVARCHARStored as a string.
DerivedNot supportedDerived fields are not supported on Zilliz Cloud.
Star-treeNot supportedStar-tree fields are not supported on Zilliz Cloud.
ArraysNot supportedArrays are not supported for migration.
MultifieldsNot supportedMultifields are not supported for migration.

OpenSearch-specific handling rules

Collection naming rules

OpenSearch index names are transferred to Zilliz Cloud with the following considerations:

ScenarioImpactSolution
Default namingCollection names match source index names exactlyNames are preserved as-is from OpenSearch
Special charactersIndex names with hyphens (-) or dots (.) will cause errors and prevent job submissionManually rename indexes to use underscores or other valid characters
Naming conflictsCannot submit job if a collection with the same name already existsDelete existing collection, choose a different database, or rename during migration configuration

Migration considerations

The following features are not supported for OpenSearch migration:

LimitationImpactAlternative
Dynamic to fixed field conversionCannot convert existing dynamic fields to fixed typesFields maintain their original dynamic nature
Add more fieldsCannot add new fields during migrationOnly existing Elasticsearch fields are migrated
Sparse vectorsNot supported in current releaseConsider dense vector alternatives or contact support for roadmap
Ctrl I