MongoDB Reader Parameters
|
Database formats include a Database Connection parameter that defines and stores authentication information. For general information about sharing database connections, please see Note that Database Connection parameters differ slightly, depending on context and/or database format. |
|
Connection From the Connection parameter in a database format, you can do one of the following:
|
|
Connection Parameters (Add Database Connection dialog) |
|---|
|
This parameter determines how the reader will build a URI to connect to MongoDB.
|
|
URI: This parameter contains a fully-specified MongoDB connection string. See the MongoDB document Connection String URI Format for more information. |
|
This parameter is enabled when Connection Type is Parameters. Protocol: This parameter must contain the protocol used to connect to MongoDB. Valid values include:
Host(s): This parameter must contain one or more hostnames or IP addresses of the source MongoDB cluster. A port may be associated with each host. If the Port parameter is left blank, then the default value of 27017 (the standard MongoDB port) will be used. Database Name: This parameter may be used to specify the database that contains the source collection(s) to be read.
Option(s): This parameter may contain one or more connection options. Each option has a name and a value. See the MongoDB document Connection String URI Format for the full set of options supported by MongoDB. |
|
This parameter is enabled when Connection Type is Parameters.
|
Constraints
After you have specified the database connection, click the Browse button (...) to select collections for import. A connection window appears while the system compiles a table from the database.
Once the list appears, you can select one or more collections, and then click OK to dismiss the window. The collection name(s) will appear in the Collections field in the parameter box.
Advanced
This parameter specifies the number of features to be retrieved from the server for each request.
If not specified, the default value is 2000.
The parameter controls whether the MongoDB reader outputs the unmodified JSON for each document in the source collection(s).
- Yes: The original JSON will be read into the mongodb_json format attribute on each source feature.
- No: The mongodb_json format attribute will not be read.
Schema Attributes
Use this parameter to expose Format Attributes in FME Workbench when you create a workspace:
- In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime.
- In a non-dynamic scenario, this parameter allows you to expose additional attributes on multiple feature types. Click the browse button to view the available format attributes (which are different for each format) for the reader.
|
A search envelope (also known as a bounding box) is a rectangular area that defines a geographic area. In FME, the easiest way to define a search envelope is to use search envelope parameters. Defining a search envelope is the most efficient method of selecting an area of interest because FME will read only the data that is necessary – it does not have to read an entire dataset. Search Envelope parameters apply to both vector and raster datasets and can be particularly efficient if the source format has a spatial index. Most FME readers have parameters to define the search envelope of data that is being read:
The parameters include the x and y coordinates of the bounding box as well as a parameter that defines the coordinate system. How to Define the Bounding Box Using the minimum and maximum x and y parameters, define a bounding box that will be used to filter the input features. Only features that intersect with the bounding box are returned. Note that the bounding box intersection is not a full geometry intersection (based on spatial relationships) that would be returned by a transformer like the SpatialFilter. Note If all four coordinates of the search envelope are left at 0, the search envelope will be disabled even if this option is checked.
|
|||||||
|
Search Envelope Coordinate System |
Specifies the coordinate system of the search envelope if it is different than the coordinate system of the data. The coordinate system associated with the data to be read must always be set if this parameter is set. If this parameter is set, the minimum and maximum points of the search envelope are reprojected from the Search Envelope Coordinate System to the reader’s coordinate system prior to applying the envelope. |
||||||
|
Clip to Search Envelope |
The underlying function for Use Search Envelope is an intersection; however, when Clip to Search Envelope is checked, a clipping operation is also performed.
|
||||||