Creating Synonyms

In this section:

How to:

Synonyms define unique names (or aliases) for each MongoDB collection that is accessible from a server. Synonyms are useful because they hide the location and identity of the underlying data source from client applications. They also provide support for extended metadata features of the server, such as virtual fields and additional security mechanisms.

Using synonyms allows an object to be moved or renamed while enabling client applications to continue functioning without modification. The only modification required is a redefinition of the synonym on the server. The result of creating a synonym is a Master File and Access File based on a given MongoDB collection.

Top of page

Procedure: How to Create a Synonym

To create a synonym, you must have previously configured the adapter and a connection.

  1. From Web Console menu bar, select Applications.


    From the Data Management Console, expand the Applications folder.

  2. Right-click an application directory, select New, and click Synonym.

    The Select Adapter dialog box opens.

  3. Under the MongoDB folder, select a connection and click OK.

    The MongoDB: Select Synonym Candidate dialog box opens.

  4. From the Restrict object type to drop-down list, select Tables, Views and Other Objects.
  5. Click Next.

    The MongoDB: Create Synonym for MongoDB dialog box opens.

  6. Optionally, expand the Customize data type mappings section and enter a value for Longchar Length or numeric precision.
  7. Select the check box for the objects for which you want to create synonyms. If you want to change the name of the synonym from the default name, click the name and edit it as needed.
  8. Click Create Synonym.

The Status pane indicates that the synonym was created successfully. The synonym is created and added under the specified application directory.

Top of page

Data Type Support

How to:

SQL Data Type mapping options are available in a report available from the Web Console.

Procedure: How to Access the Data Type Report

To access the Data Type Report:

  1. Select Adapters from the main menu.
  2. From the Troubleshooting section of the Ribbon, click the Data Types button.

    The Filter Data Types Report page opens, as shown in the following image.

  3. Select an Adapter Subcategory from the corresponding list box.
  4. Select an Adapter from the corresponding list box.
  5. Select a Server Data Type from the corresponding list box.
  6. Click Show Report.

The Filter Data Types Report is displayed, as shown in the following image.

Note: You can also display the report as a PDF by selecting the Show Report in PDF check box.