Transferring data from an OpenSearch source endpoint
Yandex Data Transfer enables you to migrate search and analytics data from an OpenSearch database and implement various data transfer, processing, and transformation scenarios. To implement a transfer:
- Explore possible data transfer scenarios.
- Prepare the OpenSearch database for the transfer.
- Set up a source endpoint in Yandex Data Transfer.
- Set up one of the supported data targets.
- Create a transfer and start it.
- Perform required operations with the database and control the transfer.
- In case of any issues, use ready-made solutions to resolve them.
Scenarios for transferring data from OpenSearch
Migration: Moving data from one storage to another. Migration often means migrating a database from obsolete local databases to managed cloud ones.
For a detailed description of possible Yandex Data Transfer scenarios, see Tutorials.
Preparing the source database
If not planning to use Cloud Interconnect or VPN
For details on linking your network up with external resources, see this concept.
Configuring the OpenSearch source endpoint
When creating or updating an endpoint, you can define:
- Yandex Managed Service for OpenSearch cluster connection or custom installation settings, including those based on Yandex Compute Cloud VMs. These are required parameters.
- Additional parameters.
Managed Service for OpenSearch cluster
Warning
To create or edit an endpoint of a managed database, you need to have the managed-opensearch.viewer
role or the viewer
primitive role assigned for the folder where this managed database cluster resides.
Connection with the cluster ID specified in Yandex Cloud.
-
Connection type: Select a cluster connection option:
-
Self-managed: Allows you to specify connection settings manually.
Select Managed Service for OpenSearch cluster as the installation type and configure these settings:
-
Managed Service for OpenSearch cluster: Select the cluster to connect to.
- User: Specify the username Data Transfer will use to connect to the cluster.
- Password: Enter the user password to the cluster.
-
-
Connection Manager: Allows connecting to the cluster via Yandex Connection Manager:
-
Select the folder with the Managed Service for OpenSearch cluster.
-
Select Managed DB cluster as the installation type and configure these settings:
- Cluster for Managed DB: Select the cluster to connect to.
- Connection: Select or create a connection in Connection Manager.
Warning
To use a connection from Connection Manager, the user must have access permissions for this connection of
connection-manager.user
or higher. -
-
-
Security groups: Select the cloud network to host the endpoint and security groups for network traffic.
Thus, you will be able to apply the specified security group rules to the VMs and clusters in the selected network without changing the settings of these VMs and clusters. For more information, see Networking in Yandex Data Transfer.
Custom installation
Connecting to nodes with explicitly specified network addresses and ports.
-
Connection type: Select a database connection option:
-
Self-managed: Allows you to specify connection settings manually.
Select Custom installation as the installation type and configure these settings:
-
Data nodes: Click
to add a new data node. For each node, specify:- Host: IP address or FQDN of the host with the
DATA
role you need to connect to. - Port: Port number Data Transfer will use to connect to the host with the
DATA
role.
- Host: IP address or FQDN of the host with the
-
SSL: Select this option if a secure SSL connection is used.
-
CA certificate: Upload the certificate file or add its contents as text if you need to encrypt the data to transfer, e.g., for compliance with the PCI DSS requirements.
Warning
If no certificate is added, the transfer may fail with an error.
-
Subnet ID: Select or create a subnet in the required availability zone. The transfer will use this subnet to access the database.
If this field has a value specified for both endpoints, both subnets must be hosted in the same availability zone.
If you do not specify a subnet, you may get an error when activating the transfer.
-
User: Specify the username Data Transfer will use to connect to the database.
-
Password: Enter the user password for access to the database.
-
-
Connection Manager: Allows connecting to the database using Yandex Connection Manager:
-
Select the folder where the Connection Manager connection was created.
-
Select Custom installation as the installation type and configure these settings:
-
Connection: Select or create a connection in Connection Manager.
-
Subnet ID: Select or create a subnet in the required availability zone. The transfer will use this subnet to access the database.
If this field has a value specified for both endpoints, both subnets must be hosted in the same availability zone.
If you do not specify a subnet, you may get an error when activating the transfer.
-
Warning
To use a connection from Connection Manager, the user must have access permissions for this connection of
connection-manager.user
or higher. -
-
-
Security groups: Select the cloud network to host the endpoint and security groups for network traffic.
Thus, you will be able to apply the specified security group rules to the VMs and DBs in the selected network without changing the settings of these VMs and DBs. For more information, see Networking in Yandex Data Transfer.
Additional settings
- Dump an index with type mapping: Select this option to move data types from a source to a target before a transfer is started. If the option is disabled and no index schema is set on the target, data types on the target will be identified automatically during a transfer.
Warning
If a source index includes data types that are not supported on the target, enabling this option may cause a transfer run error. In this case, disable the option and create an index schema on the target manually.
Configuring the data target
Configure the target endpoint:
- OpenSearch
- ClickHouse®
- Greenplum®
- Yandex Managed Service for YDB
- Yandex Object Storage
- Apache Kafka®
- YDS
For a complete list of supported sources and targets in Yandex Data Transfer, see Available transfers.
After configuring the data source and target, create and start the transfer.
Troubleshooting data transfer issues
- Transfer interrupted with an error message
- Document duplication on the target
- Exceeding the limit on the maximum number of fields
- Transfer failure with the mapper_parsing_exception error
- SSL is required error
- No tables found
For more troubleshooting tips, see Troubleshooting.
Transfer failure
Error messages:
object field starting or ending with a [.] makes object resolution ambiguous <field_description>
Index -1 out of bounds for length 0
The transfer is aborted because the keys in the documents being transferred are not valid for the OpenSearch target. Invalid keys are empty keys and keys that:
- Consist of spaces.
- Consist of periods.
- Have a period at the beginning or end.
- Have two or more periods in a row.
- Include periods separated by spaces.
Solution:
In the target endpoint additional settings, enable Sanitize documents keys and reactivate the transfer.
Document duplication on the target
When repeatedly transferring data, documents get duplicated on the target.
All documents transferred from the same source table end up under the same index named <schemaName.tableName>
on the target. In which case the target automatically generates document IDs (_id
) by default. As a result, identical documents get different IDs and get duplicated.
There is no duplication if the primary keys are specified in the source table or endpoint conversion rules. Document IDs are then generated at the transfer stage using the primary key values.
Generation is performed as follows:
- If the key value contains a period (
.
), it is escaped with\
:some.key
-->some\.key
. - All the primary key values are converted into a string:
<some_key1>.<some_key2>.<...>
. - The resulting string is converted by the url.QueryEscape
function. - If the resulting string does not exceed 512 characters in length, it is used as the
_id
. If longer than 512 characters, it is hashed with SHA-1 , and the resulting hash is used as the_id
.
As a result, documents with the same primary keys will receive the same ID when the data is transferred again, and the document transferred last will overwrite the existing one.
Solution:
- Set the primary key for one or more columns in the source table or in the endpoint conversion rules.
- Run the transfer.
Exceeding the maximum number of fields limit
Error message:
Limit of total fields [<limit_value>] has been exceeded
The transfer will be interrupted if the number of columns in the source database exceeds the maximum number of fields in the target database OpenSearch indexes.
Solution: Increase the maximum field number in the target database using the index.mapping.total_fields.limit
parameter.
Transfer failure with the mapper_parsing_exception error
Error message:
mapper_parsing_exception failed to parse field [details.tags] of type [text]
The transfer is aborted due to incompatible data types at source and target.
Solution: Move the data to a new OpenSearch index with the details
field type changed to flat_object
.
-
Deactivate the transfer.
-
Create a new index in OpenSearch:
curl \ --user <OpenSearch_username>:<password> \ --header 'Content-Type: application/json' \ --request PUT 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/<new_index_name>/_settings' \ --data '{"index.mapping.total_fields.limit": 2000}'
-
Change the
details
field type:curl \ --user <OpenSearch_username>:<password> \ --header 'Content-Type: application/json' \ --request PUT 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/<new_index_name>/_mapping' \ --data ' { "properties": { "details": { "type": "flat_object" } } }'
-
Move the data from the source index to the new one:
curl \ --user <OpenSearch_username>:<password> \ --header 'Content-Type: application/json' \ --request POST 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/_reindex' \ --data ' { "source":{ "index":"<source_index_name>" }, "dest":{ "index":"<new_index_name>" } }'
-
Delete the source index:
curl \ --user <OpenSearch_username>:<password> \ --header 'Content-Type: application/json' \ --request DELETE 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/<source_index_name>'
-
Assign an alias to the new index:
curl \ --user <OpenSearch_username>:<password> \ --header 'Content-Type: application/json' \ --request POST 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/_aliases' \ --data ' { "actions": [ { "add": { "index": "<new_alias_name>", "alias": "<source_alias_name>" } } ] }'
SSL is required error
This error occurs when connecting to a Managed Service for OpenSearch cluster as a custom installation via a OpenSearch host's FQDN if SSL is not enabled in the endpoint settings. By default, Managed Service for OpenSearch clusters require SSL encryption for connections via host FQDNs.
This error may also occur if you are connecting to a custom OpenSearch installation that requires SSL.
Solution:
Enable SSL in the endpoint settings.
For MDB clusters and other sources that use certificates issued by public CAs, you do not usually need to upload a CA certificate.
If your source uses a self-signed certificate, upload your CA certificate to the relevant field in the endpoint settings.
No tables found
Error message:
Unable to find any tables
This error may occur if the source has no available indexes or the specified user has no permissions for the indexes.
Solution:
-
Check if there is an index. Make sure that the index name was specified correctly and that the source really has the index you want to transfer.
-
Make sure the user has the required permissions to use the index.