Skip to content

Commit

Permalink
Add documentation for packages - 2024-07-09 (#1035)
Browse files Browse the repository at this point in the history
* Add documentation for packages - 2024-07-09

* Remove amazon nd weaviate from release
  • Loading branch information
eladkal authored Jul 12, 2024
1 parent f6f26d3 commit d50d7e9
Show file tree
Hide file tree
Showing 3,498 changed files with 2,323,419 additions and 1,174 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
Original file line number Diff line number Diff line change
Expand Up @@ -654,7 +654,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
<dl class="py class">
<dt class="sig sig-object py" id="airflow.providers.airbyte.hooks.airbyte.AirbyteHook">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.airbyte.hooks.airbyte.</span></span><span class="sig-name descname"><span class="pre">AirbyteHook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">airbyte_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'airbyte_default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'v1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'config'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../_modules/airflow/providers/airbyte/hooks/airbyte.html#AirbyteHook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.airbyte.hooks.airbyte.AirbyteHook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-http/stable/_api/airflow/providers/http/hooks/http/index.html#airflow.providers.http.hooks.http.HttpHook" title="(in apache-airflow-providers-http v4.11.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.http.hooks.http.HttpHook</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-http/stable/_api/airflow/providers/http/hooks/http/index.html#airflow.providers.http.hooks.http.HttpHook" title="(in apache-airflow-providers-http v4.12.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.http.hooks.http.HttpHook</span></code></a></p>
<p>Hook for Airbyte API.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
Expand Down
2 changes: 1 addition & 1 deletion docs-archive/apache-airflow-providers-amazon/stable.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8.25.0
8.25.0
Original file line number Diff line number Diff line change
Expand Up @@ -658,12 +658,12 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
<a class="reference internal" href="#airflow.providers.apache.beam.operators.beam.BeamRunGoPipelineOperator" title="airflow.providers.apache.beam.operators.beam.BeamRunGoPipelineOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">BeamRunGoPipelineOperator</span></code></a>.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="airflow.providers.apache.beam.operators.beam.BeamDataflowMixin.dataflow_hook">
<span class="sig-name descname"><span class="pre">dataflow_hook</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="/docs/apache-airflow-providers-google/stable/_api/airflow/providers/google/cloud/hooks/dataflow/index.html#airflow.providers.google.cloud.hooks.dataflow.DataflowHook" title="(in apache-airflow-providers-google v10.19.0)"><span class="pre">airflow.providers.google.cloud.hooks.dataflow.DataflowHook</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/beam/operators/beam.html#BeamDataflowMixin.dataflow_hook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.beam.operators.beam.BeamDataflowMixin.dataflow_hook" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">dataflow_hook</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="/docs/apache-airflow-providers-google/stable/_api/airflow/providers/google/cloud/hooks/dataflow/index.html#airflow.providers.google.cloud.hooks.dataflow.DataflowHook" title="(in apache-airflow-providers-google v10.20.0)"><span class="pre">airflow.providers.google.cloud.hooks.dataflow.DataflowHook</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/beam/operators/beam.html#BeamDataflowMixin.dataflow_hook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.beam.operators.beam.BeamDataflowMixin.dataflow_hook" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="airflow.providers.apache.beam.operators.beam.BeamDataflowMixin.dataflow_config">
<span class="sig-name descname"><span class="pre">dataflow_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="/docs/apache-airflow-providers-google/stable/_api/airflow/providers/google/cloud/operators/dataflow/index.html#airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration" title="(in apache-airflow-providers-google v10.19.0)"><span class="pre">airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration</span></a></em><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/beam/operators/beam.html#BeamDataflowMixin.dataflow_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.beam.operators.beam.BeamDataflowMixin.dataflow_config" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">dataflow_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="/docs/apache-airflow-providers-google/stable/_api/airflow/providers/google/cloud/operators/dataflow/index.html#airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration" title="(in apache-airflow-providers-google v10.20.0)"><span class="pre">airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration</span></a></em><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/beam/operators/beam.html#BeamDataflowMixin.dataflow_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.beam.operators.beam.BeamDataflowMixin.dataflow_config" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
Expand Down Expand Up @@ -706,7 +706,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
</p></li>
<li><p><strong>gcp_conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Optional.
The connection ID to use connecting to Google Cloud Storage if python file is on GCS.</p></li>
<li><p><strong>dataflow_config</strong> (<a class="reference external" href="/docs/apache-airflow-providers-google/stable/_api/airflow/providers/google/cloud/operators/dataflow/index.html#airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration" title="(in apache-airflow-providers-google v10.19.0)"><em>airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em> | </em><em>None</em>) – Dataflow’s configuration, used when runner type is set to DataflowRunner,
<li><p><strong>dataflow_config</strong> (<a class="reference external" href="/docs/apache-airflow-providers-google/stable/_api/airflow/providers/google/cloud/operators/dataflow/index.html#airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration" title="(in apache-airflow-providers-google v10.20.0)"><em>airflow.providers.google.cloud.operators.dataflow.DataflowConfiguration</em></a><em> | </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><em>dict</em></a><em> | </em><em>None</em>) – Dataflow’s configuration, used when runner type is set to DataflowRunner,
(optional) defaults to None.</p></li>
</ul>
</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -635,7 +635,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
<dl class="py class">
<dt class="sig sig-object py" id="airflow.providers.apache.drill.hooks.drill.DrillHook">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.apache.drill.hooks.drill.</span></span><span class="sig-name descname"><span class="pre">DrillHook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">log_sql</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/drill/hooks/drill.html#DrillHook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.drill.hooks.drill.DrillHook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/hooks/sql/index.html#airflow.providers.common.sql.hooks.sql.DbApiHook" title="(in apache-airflow-providers-common-sql v1.14.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.hooks.sql.DbApiHook</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/hooks/sql/index.html#airflow.providers.common.sql.hooks.sql.DbApiHook" title="(in apache-airflow-providers-common-sql v1.14.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.hooks.sql.DbApiHook</span></code></a></p>
<p>Interact with Apache Drill via sqlalchemy-drill.</p>
<p>You can specify the SQLAlchemy dialect and driver that sqlalchemy-drill
will employ to communicate with Drill in the extras field of your
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -635,10 +635,10 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
<dl class="py class">
<dt class="sig sig-object py" id="airflow.providers.apache.drill.operators.drill.DrillOperator">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.apache.drill.operators.drill.</span></span><span class="sig-name descname"><span class="pre">DrillOperator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">drill_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'drill_default'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/drill/operators/drill.html#DrillOperator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.drill.operators.drill.DrillOperator" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator" title="(in apache-airflow-providers-common-sql v1.14.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator" title="(in apache-airflow-providers-common-sql v1.14.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator</span></code></a></p>
<p>Executes the provided SQL in the identified Drill environment.</p>
<p>This class is deprecated.</p>
<p>Please use <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator" title="(in apache-airflow-providers-common-sql v1.14.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator</span></code></a>.</p>
<p>Please use <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator" title="(in apache-airflow-providers-common-sql v1.14.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
<dl class="py class">
<dt class="sig sig-object py" id="airflow.providers.apache.druid.hooks.druid.DruidDbApiHook">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.apache.druid.hooks.druid.</span></span><span class="sig-name descname"><span class="pre">DruidDbApiHook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/druid/hooks/druid.html#DruidDbApiHook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.druid.hooks.druid.DruidDbApiHook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/hooks/sql/index.html#airflow.providers.common.sql.hooks.sql.DbApiHook" title="(in apache-airflow-providers-common-sql v1.14.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.hooks.sql.DbApiHook</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/hooks/sql/index.html#airflow.providers.common.sql.hooks.sql.DbApiHook" title="(in apache-airflow-providers-common-sql v1.14.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.hooks.sql.DbApiHook</span></code></a></p>
<p>Interact with Druid broker.</p>
<p>This hook is purely for users to query druid broker.
For ingestion, please use druidHook.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -633,9 +633,9 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
<dl class="py class">
<dt class="sig sig-object py" id="airflow.providers.apache.druid.operators.druid_check.DruidCheckOperator">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.apache.druid.operators.druid_check.</span></span><span class="sig-name descname"><span class="pre">DruidCheckOperator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">druid_broker_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'druid_broker_default'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/apache/druid/operators/druid_check.html#DruidCheckOperator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.apache.druid.operators.druid_check.DruidCheckOperator" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLCheckOperator" title="(in apache-airflow-providers-common-sql v1.14.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLCheckOperator</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLCheckOperator" title="(in apache-airflow-providers-common-sql v1.14.1)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLCheckOperator</span></code></a></p>
<p>This class is deprecated.</p>
<p>Please use <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLCheckOperator" title="(in apache-airflow-providers-common-sql v1.14.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLCheckOperator</span></code></a>.</p>
<p>Please use <a class="reference external" href="/docs/apache-airflow-providers-common-sql/stable/_api/airflow/providers/common/sql/operators/sql/index.html#airflow.providers.common.sql.operators.sql.SQLCheckOperator" title="(in apache-airflow-providers-common-sql v1.14.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.providers.common.sql.operators.sql.SQLCheckOperator</span></code></a>.</p>
<dl class="field-list simple">
</dl>
</dd></dl>
Expand Down
Loading

0 comments on commit d50d7e9

Please sign in to comment.