docs: remove regexp_replace example

This is the same underlying issue as apache#670. The new datafusion UDF functions don't properly handle optional arguments.
Michael-J-Ward · May 10, 2024 · 4bc1781 · 4bc1781
1 parent c6bdc9f
commit 4bc1781
Show file tree

Hide file tree

Showing 8 changed files with 264 additions and 2 deletions.
diff --git a/docs/source/generated/datafusion.DataFrame.rst b/docs/source/generated/datafusion.DataFrame.rst
@@ -0,0 +1,60 @@
+datafusion.DataFrame
+====================
+
+.. currentmodule:: datafusion
+
+.. autoclass:: DataFrame
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~DataFrame.__init__
+      ~DataFrame.aggregate
+      ~DataFrame.cache
+      ~DataFrame.collect
+      ~DataFrame.collect_partitioned
+      ~DataFrame.count
+      ~DataFrame.describe
+      ~DataFrame.distinct
+      ~DataFrame.except_all
+      ~DataFrame.execute_stream
+      ~DataFrame.execute_stream_partitioned
+      ~DataFrame.execution_plan
+      ~DataFrame.explain
+      ~DataFrame.filter
+      ~DataFrame.intersect
+      ~DataFrame.join
+      ~DataFrame.limit
+      ~DataFrame.logical_plan
+      ~DataFrame.optimized_logical_plan
+      ~DataFrame.repartition
+      ~DataFrame.repartition_by_hash
+      ~DataFrame.schema
+      ~DataFrame.select
+      ~DataFrame.select_columns
+      ~DataFrame.show
+      ~DataFrame.sort
+      ~DataFrame.to_arrow_table
+      ~DataFrame.to_pandas
+      ~DataFrame.to_polars
+      ~DataFrame.to_pydict
+      ~DataFrame.to_pylist
+      ~DataFrame.union
+      ~DataFrame.union_distinct
+      ~DataFrame.unnest_column
+      ~DataFrame.with_column
+      ~DataFrame.with_column_renamed
+      ~DataFrame.write_csv
+      ~DataFrame.write_json
+      ~DataFrame.write_parquet
+
+
+
+
+
+
diff --git a/docs/source/generated/datafusion.Expr.rst b/docs/source/generated/datafusion.Expr.rst
@@ -0,0 +1,38 @@
+datafusion.Expr
+===============
+
+.. currentmodule:: datafusion
+
+.. autoclass:: Expr
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Expr.__init__
+      ~Expr.alias
+      ~Expr.canonical_name
+      ~Expr.cast
+      ~Expr.column
+      ~Expr.column_name
+      ~Expr.display_name
+      ~Expr.is_null
+      ~Expr.literal
+      ~Expr.python_value
+      ~Expr.rex_call_operands
+      ~Expr.rex_call_operator
+      ~Expr.rex_type
+      ~Expr.sort
+      ~Expr.to_variant
+      ~Expr.types
+      ~Expr.variant_name
+
+
+
+
+
+
diff --git a/docs/source/generated/datafusion.RuntimeConfig.rst b/docs/source/generated/datafusion.RuntimeConfig.rst
@@ -0,0 +1,29 @@
+datafusion.RuntimeConfig
+========================
+
+.. currentmodule:: datafusion
+
+.. autoclass:: RuntimeConfig
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~RuntimeConfig.__init__
+      ~RuntimeConfig.with_disk_manager_disabled
+      ~RuntimeConfig.with_disk_manager_os
+      ~RuntimeConfig.with_disk_manager_specified
+      ~RuntimeConfig.with_fair_spill_pool
+      ~RuntimeConfig.with_greedy_memory_pool
+      ~RuntimeConfig.with_temp_file_path
+      ~RuntimeConfig.with_unbounded_memory_pool
+
+
+
+
+
+
diff --git a/docs/source/generated/datafusion.SessionConfig.rst b/docs/source/generated/datafusion.SessionConfig.rst
@@ -0,0 +1,35 @@
+datafusion.SessionConfig
+========================
+
+.. currentmodule:: datafusion
+
+.. autoclass:: SessionConfig
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~SessionConfig.__init__
+      ~SessionConfig.set
+      ~SessionConfig.with_batch_size
+      ~SessionConfig.with_create_default_catalog_and_schema
+      ~SessionConfig.with_default_catalog_and_schema
+      ~SessionConfig.with_information_schema
+      ~SessionConfig.with_parquet_pruning
+      ~SessionConfig.with_repartition_aggregations
+      ~SessionConfig.with_repartition_file_min_size
+      ~SessionConfig.with_repartition_file_scans
+      ~SessionConfig.with_repartition_joins
+      ~SessionConfig.with_repartition_sorts
+      ~SessionConfig.with_repartition_windows
+      ~SessionConfig.with_target_partitions
+
+
+
+
+
+
diff --git a/docs/source/generated/datafusion.SessionContext.rst b/docs/source/generated/datafusion.SessionContext.rst
@@ -0,0 +1,55 @@
+datafusion.SessionContext
+=========================
+
+.. currentmodule:: datafusion
+
+.. autoclass:: SessionContext
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~SessionContext.__init__
+      ~SessionContext.catalog
+      ~SessionContext.create_dataframe
+      ~SessionContext.create_dataframe_from_logical_plan
+      ~SessionContext.deregister_table
+      ~SessionContext.empty_table
+      ~SessionContext.execute
+      ~SessionContext.from_arrow_table
+      ~SessionContext.from_pandas
+      ~SessionContext.from_polars
+      ~SessionContext.from_pydict
+      ~SessionContext.from_pylist
+      ~SessionContext.read_avro
+      ~SessionContext.read_csv
+      ~SessionContext.read_json
+      ~SessionContext.read_parquet
+      ~SessionContext.read_table
+      ~SessionContext.register_avro
+      ~SessionContext.register_csv
+      ~SessionContext.register_dataset
+      ~SessionContext.register_json
+      ~SessionContext.register_listing_table
+      ~SessionContext.register_object_store
+      ~SessionContext.register_parquet
+      ~SessionContext.register_record_batches
+      ~SessionContext.register_table
+      ~SessionContext.register_udaf
+      ~SessionContext.register_udf
+      ~SessionContext.session_id
+      ~SessionContext.sql
+      ~SessionContext.sql_with_options
+      ~SessionContext.table
+      ~SessionContext.table_exist
+      ~SessionContext.tables
+
+
+
+
+
+
diff --git a/docs/source/generated/datafusion.functions.functions.rst b/docs/source/generated/datafusion.functions.functions.rst
@@ -0,0 +1,23 @@
+datafusion.functions.functions
+==============================
+
+.. automodule:: datafusion.functions.functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/generated/datafusion.object_store.object_store.rst b/docs/source/generated/datafusion.object_store.object_store.rst
@@ -0,0 +1,23 @@
+datafusion.object\_store.object\_store
+======================================
+
+.. automodule:: datafusion.object_store.object_store
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/user-guide/common-operations/functions.rst b/docs/source/user-guide/common-operations/functions.rst
@@ -92,13 +92,12 @@ DataFusion offers a range of helpful options.
         f.left(col('"Name"'), literal(4)).alias("code")
     )
 
-This also includes the functions for regular expressions :func:`.regexp_replace` and :func:`.regexp_match`
+This also includes the functions for regular expressions like :func:`.regexp_match`
 
 .. ipython:: python
 
     df.select(
         f.regexp_match(col('"Name"'), literal("Char")).alias("dragons"),
-        f.regexp_replace(col('"Name"'), literal("saur"), literal("fleur")).alias("flowers")
     )