Skip to content

Commit b166bdd

Browse files
committed
Add text to io methods to describe the context they are using
1 parent 404e542 commit b166bdd

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

python/datafusion/io.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ def read_parquet(
3838
) -> DataFrame:
3939
"""Read a Parquet source into a :py:class:`~datafusion.dataframe.Dataframe`.
4040
41+
This function will use the global context. Any functions or tables registered
42+
with another context may not be accessible when used with a DataFrame created
43+
using this function.
44+
4145
Args:
4246
path: Path to the Parquet file.
4347
table_partition_cols: Partition columns.
@@ -81,6 +85,10 @@ def read_json(
8185
) -> DataFrame:
8286
"""Read a line-delimited JSON data source.
8387
88+
This function will use the global context. Any functions or tables registered
89+
with another context may not be accessible when used with a DataFrame created
90+
using this function.
91+
8492
Args:
8593
path: Path to the JSON file.
8694
schema: The data source schema.
@@ -120,6 +128,10 @@ def read_csv(
120128
) -> DataFrame:
121129
"""Read a CSV data source.
122130
131+
This function will use the global context. Any functions or tables registered
132+
with another context may not be accessible when used with a DataFrame created
133+
using this function.
134+
123135
Args:
124136
path: Path to the CSV file
125137
schema: An optional schema representing the CSV files. If None, the
@@ -165,6 +177,10 @@ def read_avro(
165177
) -> DataFrame:
166178
"""Create a :py:class:`DataFrame` for reading Avro data source.
167179
180+
This function will use the global context. Any functions or tables registered
181+
with another context may not be accessible when used with a DataFrame created
182+
using this function.
183+
168184
Args:
169185
path: Path to the Avro file.
170186
schema: The data source schema.

0 commit comments

Comments
 (0)