0.4.4-alpha.2: Add arrow_stream return type to Python API

Author: wangxiaoying

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "connectorx-cpp"
-version = "0.4.4-alpha.1"
+version = "0.4.4-alpha.2"
 edition = "2021"
 license = "MIT"
 

connectorx-cpp/Cargo.toml

@@ -2,7 +2,7 @@
 authors = ["Weiyuan Wu <[email protected]>"]
 edition = "2018"
 name = "connectorx-python"
-version = "0.4.4-alpha.1"
+version = "0.4.4-alpha.2"
 license = "MIT"
 readme = "README.md"
 

connectorx-python/Cargo.lock

@@ -18,7 +18,7 @@ license = "MIT"
 maintainers = ["Weiyuan Wu <[email protected]>"] 
 name = "connectorx" 
 readme = "README.md" # Markdown files are supported
-version = "0.4.4-alpha.1" 
+version = "0.4.4-alpha.2" 
 
 [project]
 name = "connectorx" # Target file name of maturin build

connectorx-python/Cargo.toml

@@ -7,7 +7,7 @@ license = "MIT"
 name = "connectorx"
 readme = "../README.md"
 repository = "https://github.com/sfu-db/connector-x"
-version = "0.4.4-alpha.1"
+version = "0.4.4-alpha.2"
 
 [dependencies]
 anyhow = "1"

connectorx-python/pyproject.toml

@@ -10,13 +10,14 @@ connectorx.read_sql(conn: Union[str, Dict[str, str]], query: Union[List[str], st
 - `conn: Union[str, Dict[str, str]]`: Connection string URI for querying single database or dict of database names (key) and connection string URIs (value) for querying multiple databases.
   - Please check out [here](https://sfu-db.github.io/connector-x/databases.html) for connection string examples of each database
 - `query: Union[str, List[str]]`: SQL query or list of partitioned SQL queries for fetching data.
-- `return_type: str = "pandas"`: The return type of this function. It can be `arrow`, `pandas`, `modin`, `dask` or `polars`.
+- `return_type: str = "pandas"`: The return type of this function. It can be `arrow`, `arrow_stream`, `pandas`, `modin`, `dask` or `polars`.
 - `protocol: str = "binary"`: The protocol used to fetch data from source, default is `binary`. Check out [here](./databases.md) to see more details.
 - `partition_on: Optional[str]`: The column to partition the result.
 - `partition_range: Optional[Tuple[int, int]]`: The value range of the partition column.
 - `partition_num: Optional[int]`: The number of partitions to generate.
 - `index_col: Optional[str]`: The index column to set for the result dataframe. Only applicable when `return_type` is `pandas`, `modin` or `dask`. 
 - `pre_execution_query: Optional[Union[str, List[str]]]`: SQL query or list of SQL queries executed before main query. Can be used to set runtime configurations using SET statements. Only applicable for source "Postgres" and "MySQL"
+- `batch_size: Optional[int]`: The maximum number of rows of each batch when `return_type=arrow_stream`.
 
 ## Examples
 - Read a DataFrame from a SQL using a single thread