ConsumerBuilder

class borneo.changestream.ConsumerBuilder

Bases: object

Builder used to create a Change Streams Consumer.

Methods Summary

add_table(table_name[, compartment, ...])	Adds a table to the Change Streams consumer configuration.
build()	Creates a Change Streams consumer using this builder configuration.
get_compartment()
get_force_reset()
get_group_id()
get_handle()
get_max_poll_interval()
get_num_tables()
get_tables()
is_manual_commit()
remove_table(table_name[, compartment])	Adds a table-removal entry to the Change Streams consumer config.
set_commit_automatic()	Sets automatic commit mode for the consumer.
set_commit_manual()	Sets manual commit mode for the consumer.
set_compartment(compartment)	Sets the compartment used for the Change Streams consumer group.
set_force_reset_start_location()	Forces existing consumer-group start locations to be reset.
set_group_id(group_id)	Sets the Change Streams consumer group ID.
set_handle(handle)	Sets the NoSQL handle used for all Change Streams operations.
set_max_poll_interval(max_poll_interval_ms)	Sets the maximum interval between consumer poll calls, in milliseconds.
validate()	Validates this builder and resolves table names to table OCIDs.
validate_table_config(table_config, handle)	Validates one table config and resolves its table OCID when needed.

Methods Documentation

add_table(table_name, compartment=None, start_location=None)

Adds a table to the Change Streams consumer configuration.

The table name may be a table OCID. The compartment is used to resolve the table name to a table OCID. If compartment is not set, the configured default compartment is used for that table lookup.

build()

Creates a Change Streams consumer using this builder configuration.

get_compartment()

get_force_reset()

get_group_id()

get_handle()

get_max_poll_interval()

get_num_tables()

get_tables()

is_manual_commit()

remove_table(table_name, compartment=None)

Adds a table-removal entry to the Change Streams consumer config.

The table name may be a table OCID. The compartment is used to resolve the table name to a table OCID. If compartment is not set, the configured default compartment is used for that table lookup.

set_commit_automatic()

Sets automatic commit mode for the consumer.

set_commit_manual()

Sets manual commit mode for the consumer.

set_compartment(compartment)

Sets the compartment used for the Change Streams consumer group.

Tables in the group may be in different compartments, as specified by add_table() and remove_table().

set_force_reset_start_location()

Forces existing consumer-group start locations to be reset.

set_group_id(group_id)

Sets the Change Streams consumer group ID.

set_handle(handle)

Sets the NoSQL handle used for all Change Streams operations.

set_max_poll_interval(max_poll_interval_ms)

Sets the maximum interval between consumer poll calls, in milliseconds.

validate()

Validates this builder and resolves table names to table OCIDs.

static validate_table_config(table_config, handle)

Validates one table config and resolves its table OCID when needed.