Skip to content

Commit db7369a

Browse files
update README
1 parent e8e26f5 commit db7369a

1 file changed

Lines changed: 1 addition & 38 deletions

File tree

README.md

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -101,43 +101,6 @@ pkeys = client.get_primary_keys("users", catalog="my_db", schema="public")
101101
- 📊 Easy result handling (Arrow, Pandas integration)
102102
- 🔧 Prepared statements and batch operations
103103

104-
## API Reference
105-
106-
### Client
107-
108-
Main client class for interacting with Altertable.
109-
110-
**Connection:**
111-
112-
- `__init__(username, password, catalog="altertable", schema="main", host="flight.altertable.ai", port=443, tls=True)`
113-
- `close()`
114-
115-
**Queries:**
116-
117-
- `execute(query, transaction_id=None)` - Execute SELECT query
118-
- `execute_update(query, transaction_id=None)` - Execute INSERT/UPDATE/DELETE
119-
- `prepare(query, transaction_id=None)` - Create prepared statement
120-
121-
**Metadata:**
122-
123-
- `get_catalogs()` - List catalogs
124-
- `get_schemas(catalog=None, schema_pattern=None)` - List schemas (uses client catalog by default)
125-
- `get_tables(catalog=None, schema_pattern=None, table_pattern=None, ...)` - List tables (uses client catalog/schema by default)
126-
- `get_primary_keys(table, catalog=None, schema=None)` - Get primary keys (uses client catalog/schema by default)
127-
128-
**Transactions:**
129-
130-
- `begin_transaction()` - Start transaction, returns transaction_id
131-
- `commit_transaction(transaction_id)` - Commit transaction
132-
- `rollback_transaction(transaction_id)` - Rollback transaction
133-
134-
### PreparedStatement
135-
136-
Represents a prepared SQL statement.
137-
138-
- `execute(parameters=None)` - Execute with optional parameters
139-
- `close()` - Release server resources
140-
141104
## Development
142105

143106
### Setup
@@ -198,7 +161,7 @@ This package includes comprehensive integration tests that validate functionalit
198161
pip install -e ".[dev]"
199162

200163
# Run all tests
201-
# Having the altertable-ai/altertable-mock docker image locally will speed things up.
164+
# Having the ghcr.io/altertable-ai/altertable-mock docker image locally will speed things up.
202165
pytest tests/
203166
```
204167

0 commit comments

Comments
 (0)