APIs

The PyDeequ SDK consists of a variety of modules:

• Core APIs
  • Analyzers
    • AnalysisRunBuilder
      • AnalysisRunBuilder.addAnalyzer()
      • AnalysisRunBuilder.run()
      • AnalysisRunBuilder.saveOrAppendResult()
      • AnalysisRunBuilder.useRepository()
    • AnalysisRunner
      • AnalysisRunner.onData()
    • AnalyzerContext
      • AnalyzerContext.successMetricsAsDataFrame()
      • AnalyzerContext.successMetricsAsJson()
    • ApproxCountDistinct
    • ApproxQuantile
    • ApproxQuantiles
    • Completeness
    • Compliance
    • Correlation
    • CountDistinct
    • DataType
    • DataTypeInstances
      • DataTypeInstances.Boolean
      • DataTypeInstances.Fractional
      • DataTypeInstances.Integral
      • DataTypeInstances.String
      • DataTypeInstances.Unknown
    • Distinctness
    • Entropy
    • Histogram
    • KLLParameters
    • KLLSketch
    • MaxLength
    • Maximum
    • Mean
    • MinLength
    • Minimum
    • MutualInformation
    • PatternMatch
    • Size
    • StandardDeviation
    • Sum
    • UniqueValueRatio
    • Uniqueness
  • Anomaly Detection
  • Checks
    • Check
      • Check.addConstraint()
      • Check.addConstraints()
      • Check.addFilterableContstraint()
      • Check.areAnyComplete()
      • Check.areComplete()
      • Check.containsCreditCardNumber()
      • Check.containsEmail()
      • Check.containsSocialSecurityNumber()
      • Check.containsURL()
      • Check.evaluate()
      • Check.hasApproxCountDistinct()
      • Check.hasApproxQuantile()
      • Check.hasCompleteness()
      • Check.hasCorrelation()
      • Check.hasDataType()
      • Check.hasDistinctness()
      • Check.hasEntropy()
      • Check.hasHistogramValues()
      • Check.hasMax()
      • Check.hasMaxLength()
      • Check.hasMean()
      • Check.hasMin()
      • Check.hasMinLength()
      • Check.hasMutualInformation()
      • Check.hasNumberOfDistinctValues()
      • Check.hasPattern()
      • Check.hasSize()
      • Check.hasStandardDeviation()
      • Check.hasSum()
      • Check.hasUniqueValueRatio()
      • Check.hasUniqueness()
      • Check.haveAnyCompleteness()
      • Check.haveCompleteness()
      • Check.isComplete()
      • Check.isContainedIn()
      • Check.isGreaterThan()
      • Check.isGreaterThanOrEqualTo()
      • Check.isLessThan()
      • Check.isLessThanOrEqualTo()
      • Check.isNonNegative()
      • Check.isPositive()
      • Check.isPrimaryKey()
      • Check.isUnique()
      • Check.kllSketchSatisfies()
      • Check.requiredAnalyzers()
      • Check.satisfies()
    • CheckLevel
      • CheckLevel.Error
      • CheckLevel.Warning
    • CheckResult
    • CheckStatus
      • CheckStatus.Error
      • CheckStatus.Success
      • CheckStatus.Warning
    • ConstrainableDataTypes
      • ConstrainableDataTypes.Boolean
      • ConstrainableDataTypes.Fractional
      • ConstrainableDataTypes.Integral
      • ConstrainableDataTypes.Null
      • ConstrainableDataTypes.Numeric
      • ConstrainableDataTypes.String
  • Profiles
  • Repository
    • FileSystemMetricsRepository
    • InMemoryMetricsRepository
    • MetricsRepository
      • MetricsRepository.after()
      • MetricsRepository.before()
      • MetricsRepository.forAnalyzers()
      • MetricsRepository.getSuccessMetricsAsDataFrame()
      • MetricsRepository.getSuccessMetricsAsJson()
      • MetricsRepository.helper_metrics_file()
      • MetricsRepository.load()
      • MetricsRepository.withTagValues()
    • ResultKey
      • ResultKey.current_milli_time()
  • Scala Utilities
    • PythonCallback
    • ScalaFunction1
      • ScalaFunction1.Java
      • ScalaFunction1.apply()
    • ScalaFunction2
      • ScalaFunction2.Java
      • ScalaFunction2.apply()
    • get_or_else_none()
    • java_list_to_python_list()
    • scala_get_default_argument()
    • scala_map_to_dict()
    • scala_map_to_java_map()
    • to_scala_map()
    • to_scala_seq()
  • Suggestions
  • Verification