Previous Topic
MongoDB Connection Wizard Dialog Box
You can use the MongoDB Connection Wizard dialog box to set up or edit a MongoDB connection in a catalog in order to get data from a MongoDB database. This topic describes the options in the dialog box.
Designer displays the MongoDB Connection Wizard dialog box when you select MongoDB and select OK in the New Data Source dialog box, or in the Catalog Manager, right-click a data source and select New MongoDB Connection from the shortcut menu, or right-click an existing MongoDB connection and select Edit Connection from the shortcut menu.
The dialog box contains the following screens:
- MongoDB Connection Information Screen
- Connection Options Screen
- Add Database Screen
- Collection Filter Screen
- Add Schema Screen
- Add Table Screen
You see these buttons in all the screens:
Back
Select to go back to the previous screen.
Next
Select to go to the next screen.
Finish
Select to finish transforming the MongoDB collections to relational schemas.
Cancel
Select to close the dialog box without saving any changes.
Help
Select to view information about the dialog box.
MongoDB Connection Information Screen
Use this screen to specify in which way to connect to the MongoDB server. You cannot change the connecting way when you use the dialog box for editing an existing MongoDB connection.
Information
Select to connect to the MongoDB server by host and port.
- Host
Specify the host for connecting to the MongoDB server. - Port
Specify the port number for connecting to the MongoDB server. - User
Specify the user ID for connecting to the MongoDB server. - Password
Specify the password of the user for connecting to the MongoDB server.
URI
Select to connect to the MongoDB server by the specified URI.
Connection Options Screen
Designer displays the Connection Options screen when you specify to connect to the MongoDB server by host and port. You can use it to specify the conditional replica set members and options for the MongoDB connection.
Replica Set Members
The box lists all the replica set members of the MongoDB connection.
Add button
Select to add a new replica set member.
Remove button
Select to delete the specified replica set member.- Host
The column shows the URIs that you specify for the replica set members. - Port
The column shows the port numbers that you specify for the replica set members.
Options
You can specify the options of the MongoDB server in the box, which are name=value pairs separated by "&".
Add Database Screen
Designer displays the Add Database screen if you specify to connect to the MongoDB server by host and port and you do not have the privilege to access all the databases in the MongoDB database. You can use it to add the databases that you can access to the MongoDB connection.
Add Database
The box lists the databases that you add to the MongoDB connection.
- Database Name
Specify the names of the databases that you can access in the MongoDB database. - Add button
Select to add a new database that you can access to the MongoDB connection. - Remove button
Select to delete the selected database.
Collection Filter Screen
Use it to specify the filter condition for the collections in the MongoDB database.
Collections
The box lists all the available collections in the MongoDB database.
Filter
Specify the filter condition for each collection to get the required collection structure; otherwise, Designer applies the first ten data records to parse metadata.
- $match
Specify to filter the documents to pass only the documents that match the specified conditions to the next pipeline stage. For the definition of $match, see https://docs.mongodb.com/manual/reference/operator/aggregation/match/#pipe._S_match.
Apply the Filter to Run Reports
Select to apply the filter conditions to the reports which use the collections at runtime.
Add Schema Screen
Use this screen to add the collections that you want to transform to relational schemas. Designer does not display this screen when you use the dialog box for editing an existing MongoDB connection.
Collections
The box lists the collections in the MongoDB database for you to select.
Added Schemas
The box lists the schemas that Designer transforms from the selected collections.
Add button
Select to add the specified collections which you want to transform to relational schemas.
Remove button
Select to remove the specified schemas from the Added Schemas box.
Add Table Screen
Use this screen to add tables that Designer transforms from the relational schemas to the MongoDB connection. Designer does not display this screen when you use the dialog box for editing an existing MongoDB connection.
Tables
The box lists the tables that Designer transforms from the relational schemas.
Added Tables
The box lists the tables that you select to add to the MongoDB connection.
Add button
Select to add the specified tables to the MongoDB connection.
Remove button
Select to remove the specified tables from the Added Tables box.