Skip to content

Commit ba61c8f

Browse files
committed
Add text to io methods to describe the context they are using
1 parent f7af294 commit ba61c8f

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
@@ -36,6 +36,10 @@ def read_parquet(
3636
) -> DataFrame:
3737
"""Read a Parquet source into a :py:class:`~datafusion.dataframe.Dataframe`.
3838
39+
This function will use the global context. Any functions or tables registered
40+
with another context may not be accessible when used with a DataFrame created
41+
using this function.
42+
3943
Args:
4044
path: Path to the Parquet file.
4145
table_partition_cols: Partition columns.
@@ -79,6 +83,10 @@ def read_json(
7983
) -> DataFrame:
8084
"""Read a line-delimited JSON data source.
8185
86+
This function will use the global context. Any functions or tables registered
87+
with another context may not be accessible when used with a DataFrame created
88+
using this function.
89+
8290
Args:
8391
path: Path to the JSON file.
8492
schema: The data source schema.
@@ -118,6 +126,10 @@ def read_csv(
118126
) -> DataFrame:
119127
"""Read a CSV data source.
120128
129+
This function will use the global context. Any functions or tables registered
130+
with another context may not be accessible when used with a DataFrame created
131+
using this function.
132+
121133
Args:
122134
path: Path to the CSV file
123135
schema: An optional schema representing the CSV files. If None, the
@@ -163,6 +175,10 @@ def read_avro(
163175
) -> DataFrame:
164176
"""Create a :py:class:`DataFrame` for reading Avro data source.
165177
178+
This function will use the global context. Any functions or tables registered
179+
with another context may not be accessible when used with a DataFrame created
180+
using this function.
181+
166182
Args:
167183
path: Path to the Avro file.
168184
schema: The data source schema.

0 commit comments

Comments
 (0)