Skip to content

Commit

Permalink
Clarify case-insensitive filtering
Browse files Browse the repository at this point in the history
  • Loading branch information
ReubenFrankel committed Dec 13, 2024
1 parent 62d2fc2 commit ae5c785
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ pipx install git+https://github.com/MeltanoLabs/tap-mongodb.git@main
| documentdb_credential_json_extra_options | string | False | - | JSON string containing key-value pairs which will be added to the connection string options when using documentdb_credential_json_string. For example, when set to the string `{"tls":"true","tlsCAFile":"my-ca-bundle.pem"}`, the options `tls=true&tlsCAFile=my-ca-bundle.pem` will be passed to the MongoClient. |
| datetime_conversion | string | False | datetime | Parameter passed to MongoClient 'datetime_conversion' parameter. See documentation at https://pymongo.readthedocs.io/en/stable/examples/datetimes.html#handling-out-of-range-datetimes for details. The default value is 'datetime', which will throw a bson.errors.InvalidBson error if a document contains a date outside the range of datetime.MINYEAR (year 1) to datetime.MAXYEAR (9999). |
| prefix | string | False | '' | An optional prefix which will be added to the name of each stream. |
| filter_collections | string[] | False | [] | Collections to discover (default: all). Useful for improving catalog discovery performance. |
| filter_collections | string[] | False | [] | Collections to discover (default: all) - filtering is case-insensitive. Useful for improving catalog discovery performance. |
| start_date | date_iso8601 | False | 1970-01-01 | Start date - used for incremental replication only. In log-based replication mode, this setting is ignored. |
| add_record_metadata | boolean | False | False | When true, _sdc metadata fields will be added to records produced by the tap. |
| allow_modify_change_streams | boolean | False | False | In AWS DocumentDB (unlike MongoDB), change streams must be enabled specifically (see the [documentation here](https://docs.aws.amazon.com/documentdb/latest/developerguide/change_streams.html#change_streams-enabling) ). If attempting to open a change stream against a collection on which change streams have not been enabled, an OperationFailure error will be raised. If this property is set to True, when this error is seen, the tap will execute an admin command to enable change streams and then retry the read operation. Note: this may incur new costs in AWS DocumentDB. |
Expand Down
5 changes: 4 additions & 1 deletion tap_mongodb/tap.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,10 @@ class TapMongoDB(Tap):
th.ArrayType(th.StringType),
required=True,
default=[],
description="Collections to discover (default: all). Useful for improving catalog discovery performance.",
description=(
"Collections to discover (default: all) - filtering is case-insensitive. Useful for improving catalog "
"discovery performance."
),
),
th.Property(
"start_date",
Expand Down

0 comments on commit ae5c785

Please sign in to comment.