What's Changed

1. Changes in POST /api/v1/responses endpoint:

If the sql_query body parameter is not set, the response is regenerated. This process generates new values for sql_query, sql_result, and response.

2. Introducing the generate_csv flag:

The generate_csv flag is a parameter that allows the generation of a CSV file populated with the sql_query_result rows. This parameter can be set in both POST /api/v1/responses and POST /api/v1/questions endpoints.

• If the file is created, the response will include the field csv_file_path. For example:

  "csv_file_path": "s3://k2-core/c6ddccfc-f355-4477-a2e7-e43f77e31bbb.csv"
  

• Additionally, if the generate_csv flag is set to True, the sql_query_result will return NULL when it contains more than 50 rows.

3. Configure S3 Credentials:

• You have the flexibility to set your S3 credentials to store the CSV files within the POST /api/v1/database-connections endpoint as follows:

    "file_storage": {
        "name": "string",
        "access_key_id": "string",
        "secret_access_key": "string",
        "region": "string",
        "bucket": "string"
    }

• If S3 credentials are not specified within the db_connection, the system will use the S3 credentials from your environment variables, as set in your .env file.

These changes will improve the consistency and maintainability of your application's data structures and APIs. If you encounter any issues during the upgrade process, please don't hesitate to reach out to our support team.

New Contributors

• @ppmarkus https://github.com/Dataherald/dataherald/commit/efdd3b0d0a8062785abd3949b64ff7b3ed9bd34c
• @roy-moven https://github.com/Dataherald/dataherald/commit/24a0ef1ab5dd112ebf39a02a40d4ec1c62446d21
• @question44 https://github.com/Dataherald/dataherald/issues/241