https://docs.greatexpectations.io/assets/js/f2979623.e3b32c2e.js

1"use strict";(globalThis.webpackChunkdocs=globalThis.webpackChunkdocs||[]).push([[479],{28453(s,e,n){n.d(e,{R:()=>i,x:()=>r});var a=n(96540);const c={},l=a.createContext(c);function i(s){const e=a.useContext(l);return a.useMemo(function(){return"function"==typeof s?s(e):{...e,...s}},[e,s])}function r(s){let e;return e=s.disableParentContext?"function"==typeof s.components?s.components(c):s.components||c:i(s.components),a.createElement(l.Provider,{value:e},s.children)}},32113(s,e,n){n.r(e),n.d(e,{assets:()=>t,contentTitle:()=>r,default:()=>x,frontMatter:()=>i,metadata:()=>a,toc:()=>p});const a=JSON.parse('{"id":"reference/api/expectations/expectation/MulticolumnMapExpectation_class","title":"MulticolumnMapExpectation","description":"class greatexpectations.expectations.expectation.MulticolumnMapExpectation(configuration: Optional[greatexpectations.core.expectation_configuration.ExpectationConfiguration] = None)#","source":"@site/versioned_docs/version-0.18/reference/api/expectations/expectation/MulticolumnMapExpectation_class.mdx","sourceDirName":"reference/api/expectations/expectation","slug":"/reference/api/expectations/expectation/MulticolumnMapExpectation_class","permalink":"/docs/0.18/reference/api/expectations/expectation/MulticolumnMapExpectation_class","draft":false,"unlisted":false,"tags":[],"version":"0.18","frontMatter":{"title":"MulticolumnMapExpectation","sidebar_label":"MulticolumnMapExpectation"},"sidebar":"gx_apis","previous":{"title":"Expectation","permalink":"/docs/0.18/reference/api/expectations/expectation/Expectation_class"},"next":{"title":"QueryExpectation","permalink":"/docs/0.18/reference/api/expectations/expectation/QueryExpectation_class"}}');var c=n(74848),l=n(28453);const i={title:"MulticolumnMapExpectation",sidebar_label:"MulticolumnMapExpectation"},r=void 0,t={},p=[];function d(s){const e={p:"p",...(0,l.R)(),...s.components};return(0,c.jsx)("section",{class:"sphinx-api-doc",id:"multicolumnmapexpectation",children:(0,c.jsxs)("dl",{class:"py class",children:[(0,c.jsxs)("dt",{class:"sig sig-object py",id:"great_expectations.expectations.expectation.MulticolumnMapExpectation",children:[(0,c.jsxs)("em",{class:"property",children:[(0,c.jsx)("span",{class:"pre",children:"class"}),(0,c.jsx)("span",{class:"w",children:" "})]}),(0,c.jsx)("span",{class:"sig-prename descclassname",children:(0,c.jsx)("span",{class:"pre",children:"great_expectations.expectations.expectation."})}),(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"MulticolumnMapExpectation"})}),(0,c.jsx)("span",{class:"sig-paren",children:"("}),(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"configuration"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/core/ExpectationConfiguration_class",title:"great_expectations.core.expectation_configuration.ExpectationConfiguration",children:(0,c.jsx)("span",{class:"pre",children:"great_expectations.core.expectation_configuration.ExpectationConfiguration"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),(0,c.jsx)("span",{class:"sig-paren",children:")"}),(0,c.jsx)("a",{class:"headerlink",href:"#great_expectations.expectations.expectation.MulticolumnMapExpectation",title:"Permalink to this definition",children:"#"})]}),(0,c.jsxs)("dd",{children:[(0,c.jsx)("p",{children:"Base class for MulticolumnMapExpectations."}),(0,c.jsx)("p",{children:"MulticolumnMapExpectations are evaluated for a set of columns and ask a yes/no question about the\nrow-wise relationship between those columns. Based on the result, they then calculate the\npercentage of rows that gave a positive answer. If the percentage is high enough,\nthe Expectation considers that data valid."}),(0,c.jsxs)("p",{children:["MulticolumnMapExpectations must implement a ",(0,c.jsx)("cite",{children:"_validate(\u2026)"})," method containing logic\nfor determining whether the Expectation is successfully validated."]}),(0,c.jsxs)("p",{children:["MulticolumnMapExpectations may optionally provide implementations of ",(0,c.jsx)("cite",{children:"val

1idate_configuration"}),",\nwhich should raise an error if the configuration will not be usable for the Expectation. By default,\nthe ",(0,c.jsx)("cite",{children:"validate_configuration"})," method will return an error if ",(0,c.jsx)("cite",{children:"column_list"})," is missing from the configuration."]}),(0,c.jsxs)("dl",{class:"field-list simple",children:[(0,c.jsx)("dt",{class:"field-odd",children:"Raises"}),(0,c.jsx)("dd",{class:"field-odd",children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"InvalidExpectationConfigurationError"})," \u2013 If ",(0,c.jsx)("cite",{children:"column_list"})," is missing from configuration."]})}),(0,c.jsx)("dt",{class:"field-even",children:"Parameters"}),(0,c.jsx)("dd",{class:"field-even",children:(0,c.jsxs)("ul",{class:"simple",children:[(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"domain_keys"})," (",(0,c.jsx)("em",{children:"tuple"}),") \u2013 A tuple of the keys used to determine the domain of the\nexpectation."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"success_keys"})," (",(0,c.jsx)("em",{children:"tuple"}),") \u2013 A tuple of the keys used to determine the success of\nthe expectation."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"default_kwarg_values"})," (",(0,c.jsx)("em",{children:"optional"}),(0,c.jsx)("em",{children:"["}),(0,c.jsx)("em",{children:"dict"}),(0,c.jsx)("em",{children:"]"}),") \u2013 Optional. A dictionary that will be used to fill unspecified\nkwargs from the Expectation Configuration."]})})]})})]}),(0,c.jsxs)("dl",{class:"py attribute",children:[(0,c.jsxs)("dt",{class:"sig sig-object py",id:"great_expectations.expectations.expectation.MulticolumnMapExpectation.domain_type",children:[(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"domain_type"})}),(0,c.jsxs)("em",{class:"property",children:[(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"pre",children:"ClassVar"})]}),(0,c.jsxs)("em",{class:"property",children:[(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"pre",children:"'multicolumn'"})]}),(0,c.jsx)("a",{class:"headerlink",href:"#great_expectations.expectations.expectation.MulticolumnMapExpectation.domain_type",title:"Permalink to this definition",children:"#"})]}),(0,c.jsx)("dd",{})]}),(0,c.jsxs)("dl",{class:"py method",children:[(0,c.jsxs)("dt",{class:"sig sig-object py",id:"great_expectations.expectations.expectation.MulticolumnMapExpectation.get_success_kwargs",children:[(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"get_success_kwargs"})}),(0,c.jsx)("span",{class:"sig-paren",children:"("}),(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"configuration"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/core/ExpectationConfiguration_class",title:"great_expectations.core.expectation_configuration.ExpectationConfiguration",children:(0,c.jsx)("span",{class:"pre",children:"great_expectations.core.expectation_configuration.ExpectationConfiguration"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),(0,c.jsx)("span",{class:"sig-paren",children:")"}),(0,c.jsxs)("span",{class:"sig-return",children:[(0,c.jsx)("span",{class:"sig-return-icon",children:"\u2192"})," ",(0,c.jsxs)("span",{class:"sig-return-typehint",children:[(0,c.jsx)("span",{class:"pre",children:"Dict"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"str"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:","})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"pre",children:"Any"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]})]}),(0,c.jsx)("a",{class:"headerlink",href:"#great_expectations.expectations.expectation.MulticolumnMapExpectation.get_success_kwargs",title:"Permalink to this definition",children:"#"})]}),(0,c.jsxs)("dd",{children:[(0,c.jsx)("p",{children:"Retrieve the success kwargs."}),(0,c.jsxs)("dl",{class:"field-list simple",children:[(0,c.jsx)("dt",{class:"field-odd",children:"Parameters"}),(0,c.jsx)("dd",{class:"field-odd",children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"configuration"})," \u2013 The ",(0,c.jsx)("cite",{children:"ExpectationConfiguration"}

1)," that contains the kwargs. If no configuration arg is provided,\nthe success kwargs from the configuration attribute of the Expectation instance will be returned."]})})]})]})]}),(0,c.jsxs)("dl",{class:"py method",children:[(0,c.jsx)("dt",{class:"sig sig-object py",id:"great_expectations.expectations.expectation.MulticolumnMapExpectation.print_diagnostic_checklist",children:(0,c.jsxs)(e.p,{children:[(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"print_diagnostic_checklist"})}),(0,c.jsx)("span",{class:"sig-paren",children:"("}),(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"diagnostics"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"great_expectations.core.expectation_diagnostics.expectation_diagnostics.ExpectationDiagnostics"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"show_failed_tests"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"bool"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"False"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"backends"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"List"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"str"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"show_debug_messages"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"bool"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"False"})})]}),(0,c.jsx)("span",{class:"sig-paren",children:")"})," ",(0,c.jsxs)("span",{class:"sig-return",children:[(0,c.jsx)("span",{class:"sig-return-icon",children:"\u2192"})," ",(0,c.jsx)("span",{class:"sig-return-typehint",children:(0,c.jsx)("span",{class:"pre",children:"str"})})]}),(0,c.jsx)("a",{class:"headerlink",href:"#great_expectations.expectations.expectation.MulticolumnMapExpectation.print_diagnostic_checklist",title:"Permalink to this definition",children:"#"})]})}),(0,c.jsxs)("dd",{children:[(0,c.jsx)("p",{children:"Runs self.run_diagnostics and generates a diagnostic checklist."}),(0,c.jsx)("p",{children:"This output from this method is a thin wrapper for ExpectationDiagnostics.generate_checklist()\nThis method is experimental."}),(0,c.jsxs)("dl",{class:"field-list simple",children:[(0,c.jsx)("dt",{class:"field-odd",children:"Parameters"}),(0,c.jsx)("dd",{class:"field-odd",children:(0,c.jsxs)("ul",{class:"simple",children:[(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"diagnostics"})," (",(0,c.jsx)("em",{children:"optional"}),(0,c.jsx)("em",{children:"["}),(0,c.jsx)("em",{children:"ExpectationDiagnostics"}),(0,c.jsx)("em",{children:"]"}),") \u2013 If diagnostics are not provided, diagnostics will be ran on self."]}

1)}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"show_failed_tests"})," (",(0,c.jsx)("em",{children:"bool"}),") \u2013 If true, failing tests will be printed."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"backends"})," \u2013 list of backends to pass to run_diagnostics"]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"show_debug_messages"})," (",(0,c.jsx)("em",{children:"bool"}),") \u2013 If true, create a logger and pass to run_diagnostics"]})})]})})]})]})]}),(0,c.jsxs)("dl",{class:"py method",children:[(0,c.jsx)("dt",{class:"sig sig-object py",id:"great_expectations.expectations.expectation.MulticolumnMapExpectation.run_diagnostics",children:(0,c.jsxs)(e.p,{children:[(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"run_diagnostics"})}),(0,c.jsx)("span",{class:"sig-paren",children:"("}),(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"raise_exceptions_for_backends"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"bool"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"False"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"ignore_suppress"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"bool"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"False"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"ignore_only_for"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"bool"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"False"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"for_gallery"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"bool"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"False"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"debug_logger"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"logging.Logger"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"only_consider_these_backends"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"List"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"str"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"context"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/data_context/AbstractDataContext_class",title:"great_expectations.data_context.AbstractDataContext",children:(0,c.jsx)("span",{class:"pre",children:"AbstractDataContext"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),(0,c.jsx)("span",{class:"sig-paren",children:")"})," ",(0,c.jsxs)("span",{class:"sig-return",children:[(0,c.jsx)("span",{class:"sig-return-icon",children:"\u2192"})," ",(0,c.jsx)("span",{class:"sig-return-typehint",children:(0,c.jsx)("span",{class:"pre",children:"ExpectationDiagnostics"})})]}),(0,c.jsx)("a",{class:"headerlink",href:"#great_expectations.expectations.expectation.MulticolumnMapExpectation.run_diagnostics",title:"Permalink to this definition",children:"#"})]})}),(0,c.jsxs)("dd",{children:[(0,c.jsx)("p",{children:"Produce a diagnostic report about this Expectation."}),(0,c.jsx)("p",{children:"The current uses for this method\u2019s output are\nusing the JSON structure to populate the Public Expectation Gallery\nand enabling a fast dev loop for developing new Expectations where the\ncontributors can quickly check the completeness of their expectations."}),(0,c.jsx)("p",{children:"The contents of the report are captured in the ExpectationDiagnostics dataclass.\nYou can see some examples in test_expectation_diagnostics.py"}),(0,c.jsx)("p",{children:"Some components (e.g. description, examples, library_metadata) of the diagnostic report can be introspected directly from the Exepctation class.\nOther components (e.g. metrics, renderers, executions) are at least partly dependent on instantiating, validating, and/or executing the Expectation class.\nFor these kinds of components, at least one test case with include_in_gallery=True must be present in the examples to\nproduce the metrics, renderers and execution engines parts of the report. This is due to\na get_validation_dependencies requiring expectation_config as an argument."}),(0,c.jsx)("p",{children:"If errors are encountered in the process of running the diagnostics, they are assumed to be due to\nincompleteness of the Expectation\u2019s implementation (e.g., declaring a dependency on Metrics\nthat do not exist). These errors are added under \u201cerrors\u201d key in the report."}),(0,c.jsxs)("dl",{class:"field-list simple",children:[(0,c.jsx)("dt",{class:"field-odd",children:"Parameters"}),(0,c.jsx)("dd",{class:"field-odd",children:(0,c.jsxs)("ul",{class:"simple",children:[(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"raise_exceptions_for_backends"})," \u2013 Bool object that when True will raise an Exception if a backend fails to connect."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"ignore_suppress"})," \u2013 Bool object that when True will ignore the suppress_test_for list on Expectation sample tests."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"ignore_only_for"})," \u2013 Bool object that when True will ignore the only_for list on Expectation sample tests."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"for_gallery"})," \u2013 Bool object that when True will create empty arrays to use as examples for the Expectation Diagnostics."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"debug_logger"})," (",(0,c.jsx)("em",{children:"optional"}),(0,c.jsx)("em",{children:"["}),(0,c.jsx)("em",{children:"logging.Logger"}),(0,c.jsx)("em",{children:"]"}),") \u2013 Logger object to use for sending debug messages to."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"only_consider_these_backends"})," (",(0,c.jsx)("em",{children:"optional"}),(0,c.jsx)("em",{children:"["}),(0,c.jsx)("em",{children:"List"}),(0,c.jsx)("em",{children:"["}),(0,c.jsx)("em",{children:"str"}),(0,c.jsx)("em",{children:"]"}),(0,c.jsx)("em",{children:"]"}),") \u2013 "]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"context"})," (",(0,c.jsx)("em",{children:"optional"}),(0,c.jsx)("em",{children:"["}),(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/data_context/AbstractDataContext_class",title:"great_expectations.data_context.AbstractDataContext",children:(0,c.jsx)("em",{children:"AbstractDataContext"})}),(0,c.jsx)("em",{children:"]"}),") \u2013 Instance of any child of \u201cAbstractDataContext\u201d class."]})})]})}),(0,c.jsx)("dt",{class:"field-even",children:"Returns"}),(0,c.jsx)("dd",{class:"field-even",children:(0,c.jsx)("p",{children:"An Expectation Diagnostics report object"})})]})]})]}),(0,c.jsxs)("dl",{class:"py method",children:[(0,c.jsx)("dt",{class:"sig sig-object py",id:"great_expectations.expectations.expectation.MulticolumnMapExpectation.validate",children:(0,c.jsxs)(e.p,{children:[(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"val

1idate"})}),(0,c.jsx)("span",{class:"sig-paren",children:"("}),(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"validator"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/validator/validator/Validator_class",title:"great_expectations.validator.validator.Validator",children:(0,c.jsx)("span",{class:"pre",children:"Validator"})})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"configuration"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/core/ExpectationConfiguration_class",title:"great_expectations.core.ExpectationConfiguration",children:(0,c.jsx)("span",{class:"pre",children:"ExpectationConfiguration"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"evaluation_parameters"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"dict"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"interactive_evaluation"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"bool"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"True"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"data_context"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/data_context/AbstractDataContext_class",title:"great_expectations.data_context.AbstractDataContext",children:(0,c.jsx)("span",{class:"pre",children:"AbstractDataContext"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"runtime_configuration"})}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:":"})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsxs)("span",{class:"n",children:[(0,c.jsx)("span",{class:"pre",children:"Optional"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"["})}),(0,c.jsx)("span",{class:"pre",children:"dict"}),(0,c.jsx)("span",{class:"p",children:(0,c.jsx)("span",{class:"pre",children:"]"})})]}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"o",children:(0,c.jsx)("span",{class:"pre",children:"="})}),(0,c.jsx)("span",{class:"w",children:" "}),(0,c.jsx)("span",{class:"default_value",children:(0,c.jsx)("span",{class:"pre",children:"None"})})]}),(0,c.jsx)("span",{class:"sig-paren",children:")"})," ",(0,c.jsxs)("span",{class:"sig-return",children:[(0,c.jsx)("span",{class:"sig-return-icon",children:"\u2192"})," ",(0,c.jsx)("span",{class:"sig-return-typehint",children:(0,c.jsx)("a",{class:"reference internal",href:"/docs/0.18/reference/api/core/ExpectationValidationResult_class",title:"great_expectations.core.ExpectationValidationResult",children:(0,c.jsx)("span",{class:"pre",children:"ExpectationValidationResult"})})})]}),(0,c.jsx)("a",{class:"headerlink",href:"#great_expectations.expectations.expectation.MulticolumnMapExpectation.validate",title:"Permalink to this definition",children:"#"})]})}),(0,c.jsxs)("dd",{children:[(0,c.jsx)("p",{children:"Validates the expectation against the provided data."}),(0,c.jsxs)("dl",{class:"field-list simple",children:[(0,c.jsx)("dt",{class:"field-odd",children:"Parameters"}),(0,c.jsx)("dd",{class:"field-odd",children:(0,c.jsxs)("ul",{class:"simple",children:[(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"val

1idator"})," \u2013 A Validator object that can be used to create Expectations, validate Expectations,\nand get Metrics for Expectations."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"configuration"})," \u2013 Defines the parameters and name of a specific expectation."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"evaluation_parameters"})," \u2013 Dictionary of dynamic values used during Validation of an Expectation."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"interactive_evaluation"})," \u2013 Setting the interactive_evaluation flag on a DataAsset\nmake it possible to declare expectations and store expectations without\nimmediately evaluating them."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"data_context"})," \u2013 An instance of a GX DataContext."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"runtime_configuration"})," \u2013 The runtime configuration for the Expectation."]})})]})}),(0,c.jsx)("dt",{class:"field-even",children:"Returns"}),(0,c.jsx)("dd",{class:"field-even",children:(0,c.jsx)("p",{children:"An ExpectationValidationResult object"})})]})]})]})]})]})})}function x(s={}){const{wrapper:e}={...(0,l.R)(),...s.components};return e?(0,c.jsx)(e,{...s,children:(0,c.jsx)(d,{...s})}):d(s)}}}]);