Skip to content

GetPlanRequest

Source code in docs_src/capo_glue/types/get_plan_request.py
class GetPlanRequest(TypedDict, closed=True):
    mapping: "capo_glue.types.mapping_list.MappingList"
    """<p>The list of mappings from a source table to target tables.</p>"""
    source: "capo_glue.types.catalog_entry.CatalogEntry"
    """<p>The source table.</p>"""
    sinks: NotRequired["capo_glue.types.catalog_entries.CatalogEntries"]
    """<p>The target tables.</p>"""
    location: NotRequired["capo_glue.types.location.Location"]
    """<p>The parameters for the mapping.</p>"""
    language: NotRequired["capo_glue.types.language.Language"]
    """<p>The programming language of the code to perform the mapping.</p>"""
    additional_plan_options_map: NotRequired[
        "capo_glue.types.additional_plan_options_map.AdditionalPlanOptionsMap"
    ]
    """<p>A map to hold additional optional key-value parameters.</p> <p>Currently, these key-value pairs are supported:</p> <ul> <li> <p> <code>inferSchema</code> — Specifies whether to set <code>inferSchema</code> to true or false for the default script generated by an Glue job. For example, to set <code>inferSchema</code> to true, pass the following key value pair:</p> <p> <code>--additional-plan-options-map '{"inferSchema":"true"}'</code> </p> </li> </ul>"""

additional_plan_options_map instance-attribute

additional_plan_options_map: NotRequired[AdditionalPlanOptionsMap]

A map to hold additional optional key-value parameters.

Currently, these key-value pairs are supported:

  • inferSchema — Specifies whether to set inferSchema to true or false for the default script generated by an Glue job. For example, to set inferSchema to true, pass the following key value pair:

    --additional-plan-options-map '{"inferSchema":"true"}'

language instance-attribute

language: NotRequired[Language]

The programming language of the code to perform the mapping.

location instance-attribute

location: NotRequired[Location]

The parameters for the mapping.

mapping instance-attribute

mapping: MappingList

The list of mappings from a source table to target tables.

sinks instance-attribute

sinks: NotRequired[CatalogEntries]

The target tables.

source instance-attribute

source: CatalogEntry

The source table.