v0.0.3
What's Changed
1. Validate Database Connection Requests 5937b35
- When a database connection is created or updated, it now attempts to establish a connection.
- If the connection is successfully established, it is stored, and a
200
response is returned. - In case of failure, a
400
error response is generated.
2. Add LLM Credentials to Database Connection Endpoints 2d9e873
- With the latest update, when creating or updating a database connection, you have the option to set LLM credentials. This allows you to use different keys for different connections
3. SSH Connection Update a66f7d8
- We have discontinued the use of the
private_key_path
field for SSH connections. - Instead, we now utilize the
path_to_credentials_file
to specify the path to the SSH private key file.
4. Enhanced Table Scanning with Background Tasks fdc3bb7
- We have implemented background tasks for asynchronous table scanning.
- The endpoint name has been updated from
/api/v1/table-descriptions/scan
to/api/v1/table-descriptions/sync-schemas
. - This enhancement ensures that even if the process operates slowly, potentially taking several minutes, the HTTP response remains consistently fast and responsive.
5. Returns Scanned Tables and Not Scanned Tables 9e2d119
- This endpoint
/api/v1/table-descriptions
should make a db connection to retrieve all the table names and check which tables have been scanned to generate a response. - The status can be:
NOT_SYNCHRONIZED
if the table has not been scannedSYNCHRONIZING
while the sync schema process is runningDEPRECATED
if there is a row in ourtable-descriptions
collection that is no longer in the database, probably because the table/view was deleted or renamedSYNCHRONIZED
when we have scanned the tableFAILED
if anything failed during the sync schema process, and theerror_message
field stores the error.
6. Migration Script from v0.0.2 to v0.0.3 9e2d119
- This script facilitates the transition from version v0.0.2 to v0.0.3 by performing the following essential task:
In the table_descriptions collection, it updates the status field to the value SYNCHRONIZED.
To execute the script, simply run the following command:
docker-compose exec app python3 -m dataherald.scripts.migrate_v002_to_v003