https://docs.greatexpectations.io/assets/js/97415cf0.c73caee5.js

1"use strict";(globalThis.webpackChunkdocs=globalThis.webpackChunkdocs||[]).push([[3420],{28453(s,e,a){a.d(e,{R:()=>r,x:()=>i});var n=a(96540);const c={},l=n.createContext(c);function r(s){const e=n.useContext(l);return n.useMemo(function(){return"function"==typeof s?s(e):{...e,...s}},[e,s])}function i(s){let e;return e=s.disableParentContext?"function"==typeof s.components?s.components(c):s.components||c:r(s.components),n.createElement(l.Provider,{value:e},s.children)}},65885(s,e,a){a.r(e),a.d(e,{assets:()=>t,contentTitle:()=>i,default:()=>o,frontMatter:()=>r,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class","title":"ConfiguredAssetAWSGlueDataCatalogDataConnector","description":"class greatexpectations.datasource.dataconnector.ConfiguredAssetAWSGlueDataCatalogDataConnector(name str, executionengine Optional[str] = None, partitions Optional[Dict[str, dict]] = None, boto3options Optional[dict] = None, id: Optional[str] = None)#","source":"@site/versioned_docs/version-0.18/reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class.mdx","sourceDirName":"reference/api/datasource/data_connector","slug":"/reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class","permalink":"/docs/0.18/reference/api/datasource/data_connector/ConfiguredAssetAWSGlueDataCatalogDataConnector_class","draft":false,"unlisted":false,"tags":[],"version":"0.18","frontMatter":{"title":"ConfiguredAssetAWSGlueDataCatalogDataConnector","sidebar_label":"ConfiguredAssetAWSGlueDataCatalogDataConnector"},"sidebar":"gx_apis","previous":{"title":"PandasDatasource","permalink":"/docs/0.18/reference/api/datasource/PandasDatasource_class"},"next":{"title":"ConfiguredAssetAzureDataConnector","permalink":"/docs/0.18/reference/api/datasource/data_connector/ConfiguredAssetAzureDataConnector_class"}}');var c=a(74848),l=a(28453);const r={title:"ConfiguredAssetAWSGlueDataCatalogDataConnector",sidebar_label:"ConfiguredAssetAWSGlueDataCatalogDataConnector"},i=void 0,t={},d=[];function p(s){const e={p:"p",...(0,l.R)(),...s.components};return(0,c.jsx)("section",{class:"sphinx-api-doc",id:"configuredassetawsgluedatacatalogdataconnector",children:(0,c.jsxs)("dl",{class:"py class",children:[(0,c.jsx)("dt",{class:"sig sig-object py",id:"great_expectations.datasource.data_connector.ConfiguredAssetAWSGlueDataCatalogDataConnector",children:(0,c.jsxs)(e.p,{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.datasource.data_connector."})}),(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"ConfiguredAssetAWSGlueDataCatalogDataConnector"})}),(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:"name"})}),(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:"str"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"datasource_name"})}),(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:"str"})})]}),", ",(0,c.jsxs)("em",{class:"sig-param",children:[(0,c.jsx)("span",{class:"n",children:(0,c.jsx)("span",{class:"pre",children:"execution_engine"})}),(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/execution_engine/ExecutionEngine_class",title:"great_expectations.execution_engine.execution_engine.ExecutionEngine",children:(0,c.jsx)("span",{class:"pre",children:"great_expectations.execution_engine.execution_engine.ExecutionEngine"})}),(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:"catalog_id"})}),(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:"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:"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:"partitions"})}),(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:"assets"})}),(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:"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:"dict"}),(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:"boto3_options"})}),(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:"batch_spec_passthrough"})}),(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:"id"})}),(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:"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:"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.datasource.data_connector.ConfiguredAssetAWSGlueDataCatalogDataConnector",title:"Permalink to this definition",children:"#"})]})}),(0,c.jsxs)("dd",{children:[(0,c.jsx)("p",{children:"A Configured Asset Data Connector used to connect to data through an AWS Glue Data Catalog."}),(0,c.jsx)("p",{children:"Being a Configured Asset Data Connector, it requires an explicit list of each Data Asset it can\nconnect to. While this allows for fine-grained control over which Data Assets may be accessed,\nit requires more setup."}),(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:"name"})," \u2013 The name of the Data Connector."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"datasource_name"})," \u2013 The name of this Data Connector\u2019s Datasource."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"execution_engine"})," \u2013 The Execution Engine object to used by this Data Connector to read the data."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"catalog_id"})," \u2013 The catalog ID from which to retrieve data. If none is provided, the AWS account\nID is used by default. Make sure you use the same catalog ID as configured in your spark session."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"partitions"})," \u2013 A list of partition keys to be defined for all Data Assets. The partitions defined in Data Asset\nconfig will override the partitions defined in the connector level."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"assets"})," \u2013 A mapping of Data Asset names to their configuration."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"boto3_options"})," \u2013 Options passed to the ",(0,c.jsx)("cite",{children:"boto3"})," library."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"batch_spec_passthrough"})," \u2013 Dictionary with keys that will be added directly to the batch spec."]})}),(0,c.jsx)("li",{children:(0,c.jsxs)("p",{children:[(0,c.jsx)("strong",{children:"id"})," \u2013 The unique identifier for this Data Connector used when running in cloud mode."]})})]})})]}),(0,c.jsxs)("dl",{class:"py method",children:[(0,c.jsxs)("dt",{class:"sig sig-object py",id:"great_expectations.datasource.data_connector.ConfiguredAssetAWSGlueDataCatalogDataConnector.get_available_data_asset_names",children:[(0,c.jsx)("span",{class:"sig-name descname",children:(0,c.jsx)("span",{class:"pre",children:"get_available_data_asset_names"})}),(0,c.jsx)("span",{class:"sig-paren",children:"("}),(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:"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)("a",{class:"headerlink",href:"#great_expectations.datasource.data_connector.ConfiguredAssetAWSGlueDataCatalogDataConnector.get_available_data_asset_names",title:"Permalink to this definition",children:"#"})]}),(0,c.jsxs)("dd",{children:[(0,c.jsx)("p",{children:"Return the list of asset names known by this DataConnector."}),(0,c.jsxs)("dl",{class:"field-list simple",children:[(0,c.jsx)("dt",{class:"field-odd",children:"Returns"}),(0,c.jsx)("dd",{class:"field-odd",children:(0,c.jsx)("p",{children:"A list of available names"})})]})]})]})]})]})})}function o(s={}){const{wrapper:e}={...(0,l.R)(),...s.components};return e?(0,c.jsx)(e,{...s,children:(0,c.jsx)(p,{...s})}):p(s)}}}]);