Skip to content

docs: update with OID and BOOL[] types #863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: update with OID and BOOL[] types #863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d70868f
docs: update with `OID` and `BOOL[]` types
Nov 11, 2025
0c732e2
docs: update CONTRIBUTING to update docs folder when adding new source
Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ MODIN_ENGINE=dask
* Add the source to the [source_router](https://github.com/sfu-db/connector-x/blob/main/connectorx-python/src/source_router.rs)
* Add the source to writing functions of each destination. Here are examples for [pandas](https://github.com/sfu-db/connector-x/blob/main/connectorx-python/src/pandas/mod.rs) and [arrow](https://github.com/sfu-db/connector-x/blob/main/connectorx-python/src/arrow.rs)
* Add corresponding unit tests under `connectorx/tests` for Rust and `connectorx-python/connectorx/tests` for Python
* Add the new source to the [docs](./docs/)

**Please check out [here](https://sfu-db.github.io/connector-x/connectorx/#extending-connectorx) for more detailed implementation instructions of how to extend ConnectorX.**

Expand Down
2 changes: 2 additions & 0 deletions docs/databases/postgres.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ cx.read_sql(conn, query) # read data from

| Postgres Type | Pandas Type | Comment |
|:---------------:|:-------------------------:|:----------------------------------:|
| OID | u32 | a data type for identifying internal objects |
| BOOL | bool, boolean(nullable) | |
| INT2 | int64, Int64(nullable) | |
| INT4 | int64, Int64(nullable) | |
Expand Down Expand Up @@ -51,6 +52,7 @@ cx.read_sql(conn, query) # read data from
| HalfVec | object | list of f32 |
| Bit | object | |
| SparseVec | object | list of f32 |
| BOOL[] | object | list of bool |
| INT2[] | object | list of i64 |
| INT4[] | object | list of i64 |
| INT8[] | object | list of i64 |
Expand Down
Loading