Skip to content

ColumnConfiguration

Source code in docs_src/capo_kendra/types/column_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class ColumnConfiguration(TypedDict, closed=True):
    document_id_column_name: "capo_kendra.types.column_name.ColumnName"
    """<p>The column that provides the document's identifier.</p>"""
    document_data_column_name: "capo_kendra.types.column_name.ColumnName"
    """<p>The column that contains the contents of the document.</p>"""
    document_title_column_name: NotRequired["capo_kendra.types.column_name.ColumnName"]
    """<p>The column that contains the title of the document.</p>"""
    field_mappings: NotRequired[
        "capo_kendra.types.data_source_to_index_field_mapping_list.DataSourceToIndexFieldMappingList"
    ]
    """<p>An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the <code>UpdateIndex</code> API.</p>"""
    change_detecting_columns: (
        "capo_kendra.types.change_detecting_columns.ChangeDetectingColumns"
    )
    """<p>One to five columns that indicate when a document in the database has changed.</p>"""

change_detecting_columns instance-attribute 

change_detecting_columns: ChangeDetectingColumns

One to five columns that indicate when a document in the database has changed.

document_data_column_name instance-attribute 

document_data_column_name: ColumnName

The column that contains the contents of the document.

document_id_column_name instance-attribute 

document_id_column_name: ColumnName

The column that provides the document's identifier.

document_title_column_name instance-attribute 

document_title_column_name: NotRequired[ColumnName]

The column that contains the title of the document.

field_mappings instance-attribute 

field_mappings: NotRequired[DataSourceToIndexFieldMappingList]

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.