great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values

Module Contents

Classes

ColumnQuantileValues()

Base class for all metric providers.

Functions

_get_column_quantiles_mssql(column, quantiles: Iterable, selectable, sqlalchemy_engine)

_get_column_quantiles_bigquery(column, quantiles: Iterable, selectable, sqlalchemy_engine)

_get_column_quantiles_mysql(column, quantiles: Iterable, selectable, sqlalchemy_engine)

_get_column_quantiles_trino(column, quantiles: Iterable, selectable, sqlalchemy_engine)

_get_column_quantiles_sqlite(column, quantiles: Iterable, selectable, sqlalchemy_engine, table_row_count)

The present implementation is somewhat inefficient, because it requires as many calls to

_get_column_quantiles_athena(column, quantiles: Iterable, selectable, sqlalchemy_engine)

_get_column_quantiles_generic_sqlalchemy(column, quantiles: Iterable, allow_relative_error: bool, dialect, selectable, sqlalchemy_engine)

great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values.logger
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values.TrinoUserError
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values.ProgrammingError
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values.Row
class great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values.ColumnQuantileValues

Bases: great_expectations.expectations.metrics.column_aggregate_metric_provider.ColumnAggregateMetricProvider

Base class for all metric providers.

MetricProvider classes must have the following attributes set:
  1. metric_name: the name to use. Metric Name must be globally unique in a great_expectations installation.

  1. domain_keys: a tuple of the keys used to determine the domain of the metric

  2. value_keys: a tuple of the keys used to determine the value of the metric.

In some cases, subclasses of Expectation, such as TableMetricProvider will already have correct values that may simply be inherited.

They may optionally override the default_kwarg_values attribute.

MetricProvider classes must implement the following:

1. _get_evaluation_dependencies. Note that often, _get_evaluation_dependencies should augment dependencies provided by a parent class; consider calling super()._get_evaluation_dependencies

In some cases, subclasses of Expectation, such as MapMetricProvider will already have correct implementations that may simply be inherited.

Additionally, they may provide implementations of:

1. Data Docs rendering methods decorated with the @renderer decorator. See the guide “How to create renderers for custom expectations” for more information.

metric_name = column.quantile_values
value_keys = ['quantiles', 'allow_relative_error']
_pandas(cls, column, quantiles, allow_relative_error, **kwargs)

Quantile Function

_sqlalchemy(cls, execution_engine: SqlAlchemyExecutionEngine, metric_domain_kwargs: dict, metric_value_kwargs: dict, metrics: Dict[str, Any], runtime_configuration: dict)
_spark(cls, execution_engine: SqlAlchemyExecutionEngine, metric_domain_kwargs: dict, metric_value_kwargs: dict, metrics: Dict[str, Any], runtime_configuration: dict)
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values._get_column_quantiles_mssql(column, quantiles: Iterable, selectable, sqlalchemy_engine) → list
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values._get_column_quantiles_bigquery(column, quantiles: Iterable, selectable, sqlalchemy_engine) → list
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values._get_column_quantiles_mysql(column, quantiles: Iterable, selectable, sqlalchemy_engine) → list
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values._get_column_quantiles_trino(column, quantiles: Iterable, selectable, sqlalchemy_engine) → list
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values._get_column_quantiles_sqlite(column, quantiles: Iterable, selectable, sqlalchemy_engine, table_row_count) → list

The present implementation is somewhat inefficient, because it requires as many calls to “sqlalchemy_engine.execute()” as the number of partitions in the “quantiles” parameter (albeit, typically, only a few). However, this is the only mechanism available for SQLite at the present time (11/17/2021), because the analytical processing is not a very strongly represented capability of the SQLite database management system.

great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values._get_column_quantiles_athena(column, quantiles: Iterable, selectable, sqlalchemy_engine) → list
great_expectations.expectations.metrics.column_aggregate_metrics.column_quantile_values._get_column_quantiles_generic_sqlalchemy(column, quantiles: Iterable, allow_relative_error: bool, dialect, selectable, sqlalchemy_engine) → list