MongoDB

Connect MongoDB to your preprocessing pipeline, and use the Unstructured Ingest CLI or the Unstructured Ingest Python library to batch process all your documents and store structured outputs locally on your filesystem.

The requirements are as follows.

The MongoDB requirements for a MongoDB Atlas deployment include:

• A MongoDB Atlas account. Create an account.

• A MongoDB Atlas cluster. Create a cluster.

• The cluster must be reachable from your application environment. Learn how.

• The cluster must be configured to allow IP address. Learn how.

  To get Unstructured’s IP address ranges, go to https://assets.p6m.u10d.net/publicitems/ip-prefixes.json and allow all of the ip_prefix fields’ values that are listed.

  These IP address ranges are subject to change. You can always find the latest ones in the preceding file.

• The cluster must have at least one database. Create a database.

• The database must have at least one user, and that user must have sufficient access to the database. Create a database user. Give the user database access.

• The database must have at least one collection. Create a collection.

  For the destination connector, Unstructured recommends that all documents in the target collection have a field named record_id with a String data type. Unstructured can use this field to do intelligent document overwrites. Without this field, duplicate documents might be written to the collection or, in some cases, the operation could fail altogether.

• The connection string for the cluster. For MongoDB Atlas, this connection string must include the protocol, username, password, host, and cluster name. For example:

  mongodb+srv://<db_user>:<db_password>@<host>/?retryWrites=true&w=majority&appName=<cluster>
  

  To get the connection string in MongoDB Atlas, do the following:

  1. Log in to your MongoDB Atlas console.

  2. In the sidebar, under Databases, click Clusters.

  3. Click on the cluster you want to connect to.

  4. Click Connect, or click the Cmd Line Tools tab and then click Connect Instructions.

  5. Click Drivers.

  6. Under Add your connection string into your application code, copy the connection string. You can then close the Connect dialog in MongoDB Atlas.

     Before you use this connection string, be sure to fill in any placeholders in the string, such as your MongoDB Atlas database user’s password value.

  Learn more.

The MongoDB connector dependencies:

pip install "unstructured-ingest[mongodb]"

You might also need to install additional dependencies, depending on your needs. Learn more.

For a MongoDB Atlas deployment, the following environment variables:

• MONGODB_DATABASE - The name of the database, represented by --database (CLI) or database (Python).

• MONGODB_COLLECTION - The name of the collection in the database, represented by --collection (CLI) or collection (Python).

• MONGODB_URI - The connection string for the cluster, represented by --uri (CLI) or uri (Python).

For a local MongoDB server, the following environment variables:

• MONGODB_HOST - The host for the local MongoDB server, represented by --host (CLI) or host (Python).

• MONGODB_PORT - The port for the local MongoDB server, represented by --port (CLI) or port (Python).

Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The destination connector can be any of the ones supported. This example uses the local destination connector:

This example sends data to Unstructured API services for processing by default. To process data locally instead, see the instructions at the end of this page.

For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --partition-by-api option (CLI) or partition_by_api (Python) parameter to specify where files are processed:

• To do local file processing, omit --partition-by-api (CLI) or partition_by_api (Python), or explicitly specify partition_by_api=False (Python).

  Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:

  • --api-key $UNSTRUCTURED_API_KEY (CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY") (Python)
  • --partition-endpoint $UNSTRUCTURED_API_URL (CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL") (Python)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL

• To send files to Unstructured API services for processing, specify --partition-by-api (CLI) or partition_by_api=True (Python).

  Unstructured API services also requires an Unstructured API key and API URL, by adding the following:

  • --api-key $UNSTRUCTURED_API_KEY (CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY") (Python)
  • --partition-endpoint $UNSTRUCTURED_API_URL (CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL") (Python)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL, representing your API key and API URL, respectively.

  Get an API key and API URL.