@@ -2123,20 +2123,28 @@ def connect_to_table(connection_string: str) -> Any:
2123
2123
----------
2124
2124
connection_string
2125
2125
A database connection string with a required table specification using the `::table_name`
2126
- suffix. Supported formats include:
2127
-
2128
- - DuckDB: `"duckdb:///path/to/database.ddb::table_name"`
2129
- - SQLite: `"sqlite:///path/to/database.db::table_name"`
2130
- - PostgreSQL: `"postgresql://user:password@localhost:5432/database::table_name"`
2131
- - MySQL: `"mysql://user:password@localhost:3306/database::table_name"`
2132
- - BigQuery: `"bigquery://project/dataset::table_name"`
2133
- - Snowflake: `"snowflake://user:password@account/database/schema::table_name"`
2126
+ suffix. Supported formats are outlined in the *Supported Connection String Formats* section.
2134
2127
2135
2128
Returns
2136
2129
-------
2137
2130
Any
2138
2131
An Ibis table object for the specified database table.
2139
2132
2133
+ Supported Connection String Formats
2134
+ -----------------------------------
2135
+ The `connection_string` parameter must include a valid connection string with a table name
2136
+ specified using the `::` syntax. For example:
2137
+
2138
+ - DuckDB: `"duckdb:///path/to/database.ddb::table_name"`
2139
+ - SQLite: `"sqlite:///path/to/database.db::table_name"`
2140
+ - PostgreSQL: `"postgresql://user:password@localhost:5432/database::table_name"`
2141
+ - MySQL: `"mysql://user:password@localhost:3306/database::table_name"`
2142
+ - BigQuery: `"bigquery://project/dataset::table_name"`
2143
+ - Snowflake: `"snowflake://user:password@account/database/schema::table_name"`
2144
+
2145
+ If the connection string does not include a table name, the function will attempt to connect to
2146
+ the database and list available tables, providing guidance on how to specify a table.
2147
+
2140
2148
Examples
2141
2149
--------
2142
2150
Connect to a DuckDB table:
0 commit comments