sdkagent

great_expectations API reference

85 public APIs from great_expectations (great-expectations/great_expectations) — 57 classes, 8 functions, 20 methods. Signatures extracted by static analysis of the actual source.

Repository: great-expectations/great_expectations

KindCount
Classes57
Functions8
Methods20

API list

funcci.checks.validate_docs_snippets.parse_grep(lines:list[str]) -> list[str]
Parse the grep output and exclude known issues.
funccontrib.cli.great_expectations_contrib.cli.cli(ctx:click.Context) -> None
Welcome to the great_expectations_contrib CLI!
classgreat_expectations.checkpoint.actions.OpsgenieAlertAction
Sends an Opsgenie alert.
classgreat_expectations.checkpoint.actions.PagerdutyAlertAction
Sends a PagerDuty event.
methodgreat_expectations.checkpoint.checkpoint.Checkpoint.save() -> None
Save the current state of this Checkpoint.
classgreat_expectations.checkpoint.checkpoint.CheckpointResult
The result of running a Checkpoint.
classgreat_expectations.compatibility.aws.REDSHIFT_TYPES
Namespace for Redshift dialect types.
classgreat_expectations.compatibility.bigquery.BIGQUERY_TYPES
Namespace for Bigquery dialect types
classgreat_expectations.compatibility.databricks.DATABRICKS_TYPES
Namespace for Databricks dialect types
classgreat_expectations.compatibility.postgresql.POSTGRESQL_TYPES
Namespace for PostgreSQL dialect types.
classgreat_expectations.compatibility.snowflake.SNOWFLAKE_TYPES
Namespace for Snowflake dialect types.
classgreat_expectations.core.batch.Batch
A Batch is a selection of records from a Data Asset.
methodgreat_expectations.core.batch.Batch.data() -> BatchDataType | None
Getter for Batch data
methodgreat_expectations.core.batch.Batch.head(n_rows:int=5, fetch_all:bool=False) -> pd.DataFrame
Return the first n rows from the Batch.
classgreat_expectations.core.batch_definition.BatchDefinition
Configuration for a batch of data.
methodgreat_expectations.core.batch_definition.BatchDefinition.get_batch(batch_parameters:Optional[BatchParameters]=None) -> Batch
Retrieves a batch from the underlying asset.
classgreat_expectations.core.configuration.AbstractConfig
Abstract base class for Config objects.
classgreat_expectations.core.expectation_suite.ExpectationSuite
Set-like collection of Expectations.
methodgreat_expectations.core.expectation_suite.ExpectationSuite.add_expectation(expectation:_TExpectation) -> _TExpectation
Add an Expectation to the collection.
methodgreat_expectations.core.expectation_suite.ExpectationSuite.delete_expectation(expectation:Expectation) -> Expectation
Delete an Expectation from the collection.
methodgreat_expectations.core.expectation_suite.ExpectationSuite.save() -> None
Save this ExpectationSuite.
classgreat_expectations.core.expectation_validation_result.ExpectationValidationResult
An Expectation validation result.
classgreat_expectations.core.serializer.AbstractConfigSerializer
Serializer interface.
methodgreat_expectations.core.serializer.AbstractConfigSerializer.serialize(obj:AbstractConfig) -> dict
Serialize to serializer specific data type.
funcgreat_expectations.core.suite_parameters.get_suite_parameter_key(suite_parameter:SuiteParameterDict) -> str
Get the key of a suite parameter.
funcgreat_expectations.core.util.sniff_s3_compression(s3_url:S3Url) -> Union[str, None]
Attempts to get read_csv compression from s3_url
funcgreat_expectations.data_context.store.gx_cloud_store_backend.close_session(session:requests.Session)
Close the session.
classgreat_expectations.data_context.store.tuple_store_backend.TupleFilesystemStoreBackend
Uses a local filepath as a store.
classgreat_expectations.data_context.types.base.DataContextConfig
Config class for DataContext.
classgreat_expectations.data_context.types.resource_identifiers.BatchIdentifier
A BatchIdentifier tracks
classgreat_expectations.data_context.util.PasswordMasker
Used to mask passwords in Datasources.
methodgreat_expectations.data_context.util.PasswordMasker.sanitize_config(config:dict) -> dict
Mask sensitive fields in a Dict.
classgreat_expectations.datasource.fluent.config.GxConfig
Represents the full fluent configuration file.
classgreat_expectations.datasource.fluent.fabric.FabricPowerBIDatasource
Microsoft Fabric Datasource.
classgreat_expectations.datasource.fluent.fabric.PowerBIDax
Microsoft PowerBI DAX.
classgreat_expectations.datasource.fluent.fabric.PowerBIMeasure
Microsoft PowerBI Measure.
classgreat_expectations.datasource.fluent.fabric.PowerBITable
Microsoft PowerBI Table.
classgreat_expectations.datasource.fluent.interfaces.Batch
This represents a batch of data.
methodgreat_expectations.datasource.fluent.interfaces.Batch.columns() -> List[str]
Return column names of this Batch.
methodgreat_expectations.datasource.fluent.interfaces.Batch.head(n_rows:StrictInt=5, fetch_all:StrictBool=False) -> HeadData
Return the first n rows of this Batch.
methodgreat_expectations.datasource.fluent.interfaces.Datasource.get_batch(batch_request:BatchRequest) -> Batch
A Batch that corresponds to the BatchRequest.
classgreat_expectations.datasource.fluent.invalid_datasource.InvalidAsset
A DataAsset that is invalid.
classgreat_expectations.datasource.fluent.invalid_datasource.InvalidDatasource
A Datasource that is invalid.
methodgreat_expectations.datasource.fluent.snowflake_datasource.SnowflakeDsn.account() -> AccountIdentifier
Alias for account_identifier.
methodgreat_expectations.datasource.fluent.snowflake_datasource.SnowflakeDsn.account_identifier() -> AccountIdentifier
Alias for host.
classgreat_expectations.exceptions.exceptions.PluginClassNotFoundError
A module import failed.
classgreat_expectations.exceptions.exceptions.PluginModuleNotFoundError
A module import failed.
methodgreat_expectations.execution_engine.execution_engine.ExecutionEngine.batch_manager() -> BatchManager
Getter for batch_manager
classgreat_expectations.expectations.expectation.BatchExpectation
Base class for BatchExpectations.
classgreat_expectations.expectations.expectation.ColumnMapExpectation
Base class for ColumnMapExpectations.
classgreat_expectations.expectations.expectation.ColumnPairMapExpectation
Base class for ColumnPairMapExpectations.
classgreat_expectations.expectations.expectation.Expectation
Base class for all Expectations.
classgreat_expectations.expectations.expectation.QueryExpectation
Base class for QueryExpectations.
classgreat_expectations.expectations.metadata_types.FailureSeverity
Severity levels for Expectation failures.
classgreat_expectations.expectations.metrics.metric_provider.MetricProvider
Base class for all metric providers.
classgreat_expectations.expectations.row_conditions.Column
Specify the column in a condition statement.
classgreat_expectations.expectations.row_conditions.Condition
Base class for conditions.
methodgreat_expectations.experimental.metric_repository.cloud_data_store.CloudDataStore.add(value:T) -> uuid.UUID
Add a value to the DataStore.
funcgreat_expectations.experimental.metric_repository.cloud_data_store.close_session(session:requests.Session)
Close the session.
methodgreat_expectations.experimental.metric_repository.data_store.DataStore.add(value:T) -> uuid.UUID
Add a value to the DataStore.
classgreat_expectations.experimental.metric_repository.metrics.Metric
Abstract computed metric.
classgreat_expectations.metrics.batch.batch_column_types.BatchColumnTypes
Table schema
classgreat_expectations.metrics.batch.row_count.BatchRowCount
Count of rows in a table
classgreat_expectations.metrics.batch.sample_values.SampleValues
Sample rows from a table
classgreat_expectations.metrics.column.distinct_values.ColumnDistinctValues
List of distinct values in a column
classgreat_expectations.metrics.column.distinct_values_count.ColumnDistinctValuesCount
Count of distinct values in a column
classgreat_expectations.metrics.column.mean.ColumnMean
Mean of values in a column
classgreat_expectations.metrics.column.null_count.ColumnNullCount
Count of null values in a column
classgreat_expectations.metrics.column.values_non_null.ColumnValuesNonNullCount
Count of non-null values in a column
classgreat_expectations.metrics.metric.Metric
The abstract base class for defining all metrics.
classgreat_expectations.render.components.AtomicDiagnosticRendererType
Available atomic diagnostic renderer names
classgreat_expectations.render.components.AtomicRendererType
Available atomic renderer types
classgreat_expectations.render.components.LegacyDiagnosticRendererType
Available legacy diagnostic renderer names
classgreat_expectations.render.components.LegacyRendererType
Available legacy renderer types
classgreat_expectations.render.components.RendererPrefix
Available renderer prefixes
methodgreat_expectations.render.renderer.renderer.Renderer.render(checkpoint_result:CheckpointResult) -> Any
Render interface method.
classgreat_expectations.render.renderer_configuration.RendererSchema
Json schema for values found in renderers.
funcgreat_expectations.render.util.ordinal(num)
Convert a number to ordinal
classgreat_expectations.render.view.view.DefaultMarkdownPageView
Convert a document to markdown format.
methodgreat_expectations.render.view.view.DefaultMarkdownPageView.render(document:list, template=None, **kwargs) -> list[str] | str
Handle list as well as single document
classgreat_expectations.types.connect_args.ConnectArgs
Type definition for connection arguments.
funcgreat_expectations.util.is_sane_slack_webhook(url:str) -> bool
Really basic sanity checking.
classgreat_expectations.validator.metric_configuration.MetricConfiguration
An interface for configuring Metrics.
classgreat_expectations.validator.v1_validator.Validator
Validator.
methodgreat_expectations.validator.validator.Validator.columns(domain_kwargs:Optional[Dict[str, Any]]=None) -> List[str]
Convenience method to obtain Batch columns.

About this data

These signatures were extracted from the public source of great-expectations/great_expectations using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries