great_expectations.cli.batch_request

Module Contents

Functions

get_batch_request(datasource: BaseDatasource, additional_batch_request_args: Optional[Dict[str, Any]] = None)

This method manages the interaction with user necessary to obtain batch_request for a batch of a data asset.

select_data_connector_name(available_data_asset_names_by_data_connector_dict: Optional[Dict[str, List[str]]] = None)

_get_data_asset_name_from_data_connector(datasource: BaseDatasource, data_connector_name: str, msg_prompt_enter_data_asset_name: str)

Prompts the user to provide a data asset name from a list generated by a data connector

_list_available_data_asset_names(available_data_asset_names: List[str], msg_prompt_enter_data_asset_name: str)

_search_through_available_data_asset_names(available_data_asset_names: List[str], msg_prompt_enter_data_asset_name: str)

_get_data_asset_name_for_simple_sqlalchemy_datasource(datasource: SimpleSqlalchemyDatasource, data_connector_name: str, msg_prompt_enter_data_asset_name: str)

_get_default_schema(datasource: SimpleSqlalchemyDatasource)

_check_default_data_connectors(available_data_asset_names_by_data_connector_dict: Dict[str, List[str]])

_get_batch_spec_passthrough(datasource: BaseDatasource)

_get_user_response(prompt: str)

great_expectations.cli.batch_request.parse_bigquery_url
great_expectations.cli.batch_request.logger
great_expectations.cli.batch_request.sqlalchemy
great_expectations.cli.batch_request.DEFAULT_DATA_CONNECTOR_NAMES :Final[List[str]] = ['default_runtime_data_connector_name', 'default_inferred_data_connector_name']
great_expectations.cli.batch_request.get_batch_request(datasource: BaseDatasource, additional_batch_request_args: Optional[Dict[str, Any]] = None) → Dict[str, Union[str, Dict[str, Any]]]

This method manages the interaction with user necessary to obtain batch_request for a batch of a data asset.

In order to get batch_request this method needs datasource_name, data_connector_name and data_asset_name to combine them into a batch_request dictionary.

All three arguments are optional. If they are present, the method uses their values. Otherwise, the method prompts user to enter them interactively. Since it is possible for any of these three components to be passed to this method as empty values and to get their values after interacting with user, this method returns these components’ values in case they changed.

If the datasource has data connectors, the method lets user choose a name from that list (note: if there are multiple data connectors, user has to choose one first).

# :param datasource: # :param additional_batch_request_args: # :return: batch_request

great_expectations.cli.batch_request.select_data_connector_name(available_data_asset_names_by_data_connector_dict: Optional[Dict[str, List[str]]] = None) → Optional[str]
great_expectations.cli.batch_request._get_data_asset_name_from_data_connector(datasource: BaseDatasource, data_connector_name: str, msg_prompt_enter_data_asset_name: str) → Optional[str]

Prompts the user to provide a data asset name from a list generated by a data connector

Parameters
  • datasource – The datasource that contains our target data connector

  • data_connector_name – Used to retrieve the target data connector; this connector is then used to list available data assets

  • msg_prompt_enter_data_asset_name – CLI prompt to request user input

Returns

The name of the data asset (if provided)

great_expectations.cli.batch_request._list_available_data_asset_names(available_data_asset_names: List[str], msg_prompt_enter_data_asset_name: str) → Optional[str]
great_expectations.cli.batch_request._search_through_available_data_asset_names(available_data_asset_names: List[str], msg_prompt_enter_data_asset_name: str) → Optional[str]
great_expectations.cli.batch_request._get_data_asset_name_for_simple_sqlalchemy_datasource(datasource: SimpleSqlalchemyDatasource, data_connector_name: str, msg_prompt_enter_data_asset_name: str) → str
great_expectations.cli.batch_request._get_default_schema(datasource: SimpleSqlalchemyDatasource) → str
great_expectations.cli.batch_request._check_default_data_connectors(available_data_asset_names_by_data_connector_dict: Dict[str, List[str]]) → Optional[str]
great_expectations.cli.batch_request._get_batch_spec_passthrough(datasource: BaseDatasource) → Dict[str, Union[str, Dict[str, Any]]]
great_expectations.cli.batch_request._get_user_response(prompt: str) → str