Skip to content

MongoDBTarget

Source code in docs_src/capo_glue/types/mongo_db_target.py 
13
14
15
16
17
18
19
class MongoDBTarget(TypedDict, closed=True):
    connection_name: NotRequired["capo_glue.types.connection_name.ConnectionName"]
    """<p>The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.</p>"""
    path: NotRequired["capo_glue.types.path.Path"]
    """<p>The path of the Amazon DocumentDB or MongoDB target (database/collection).</p>"""
    scan_all: NotRequired["capo_glue.types.nullable_boolean.NullableBoolean"]
    """<p>Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.</p> <p>A value of <code>true</code> means to scan all records, while a value of <code>false</code> means to sample the records. If no value is specified, the value defaults to <code>true</code>.</p>"""

connection_name instance-attribute 

connection_name: NotRequired[ConnectionName]

The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target.

path instance-attribute 

path: NotRequired[Path]

The path of the Amazon DocumentDB or MongoDB target (database/collection).

scan_all instance-attribute 

scan_all: NotRequired[NullableBoolean]

Indicates whether to scan all the records, or to sample rows from the table. Scanning all the records can take a long time when the table is not a high throughput table.

A value of true means to scan all records, while a value of false means to sample the records. If no value is specified, the value defaults to true.