migration-name.txt

.. _c2c-beta-migration-name:

=============
migrationName
=============

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 2
   :class: singlecol

.. include:: /includes/beta-feature.rst

.. include:: /includes/migrationName.rst

Syntax 
------

To set ``migrationName`` from the command line, use the ``--migrationName`` 
setting:

.. code-block:: shell

   ./bin/mongosync \
         --cluster0 <connection-string> \
         --cluster1 <connection-string>  \
         --migrationName <string>

To set ``migrationName`` in a :ref:`configuration file <c2c-config>`, 
include the ``migrationName`` option:

.. code-block:: yaml

   cluster0: <connection-string>
   cluster1: <connection-string>
   migrationName: <string>

Behavior 
--------

The ``migrationName`` string can contain up to 44 alphanumeric and underscore 
characters. ``migrationName`` is appended to the string 
``"mongosync_internal_"`` to set the migration metadata database name.

For example, if you set ``migrationName`` to 
``"cluster_27000_to_cluster_35000_sync"``, the resulting ``mongosync`` metadata 
database name is ``"mongosync_internal_cluster_27000_to_cluster_35000_sync"``.

.. _c2c-beta-multiple-migration-examples:

Examples
--------

To view examples that use ``migrationName``, see: 

- :ref:`c2c-beta-abc-migration`
- :ref:`c2c-beta-many-to-one`

Learn More 
----------

- :ref:`c2c-beta-program`