Skip to main content

How to Refresh Database Columns

Learn how to keep your external database connection up to date

Updated yesterday

Column Refresh is a feature that allows you to fetch newly added columns from your external database tables without having to reconfigure the entire datasource. This is particularly useful when your database schema evolves over time and you want to make new columns available to your agents while preserving your existing custom descriptions.

When to Use Column Refresh

You should use the Column Refresh feature when:

  • Your database has added new columns to tables that you've already connected to elvex

  • You want to make these new columns immediately available to your agents

  • You want to preserve your existing custom descriptions and configurations

  • You prefer a quick update over reconfiguring the entire database connection

What Gets Updated

When you refresh columns, elvex will:

  • Identify new columns in existing tables that you've already connected

  • Preserve existing configurations - your current table selections and custom column descriptions remain unchanged

  • Skip column modifications - changes to existing columns (like data type changes) are not included

How to Refresh Columns

Step 1: Navigate to Your Database Datasource

  1. Go to the Datasources section in elvex

  2. Find and open the database datasource you want to update

  3. Click Edit to access the configuration

Step 2: Review the Refresh Card

In the datasource configuration view, you'll see a "Refresh Columns" card that shows:

  • A description of what the refresh will do

  • A Refresh button to initiate the process

Step 3: Initiate the Refresh

  1. Click the Refresh button

  2. elvex will connect to your database and analyze the schema

  3. This may take a few moments depending on your database size and connection speed

Step 4: Review Detected Changes

Once the refresh completes, you'll see a preview showing:

  • New columns organized by table, with their:

    • Column name

    • Data type (e.g., VARCHAR, INTEGER, TIMESTAMP)

    • Primary key indicator

    • Unique constraint indicator

    • Auto-generated description

Step 5: Customize Column Descriptions (Optional)

  1. For each column, you can edit the Description field

  2. These descriptions help your agents understand the column's purpose and use it more effectively

  3. If elvex has auto-generated a description from your database comments, you can keep it or modify it

Step 6: Apply Changes

  1. Click the Apply Changes button to add the columns

  2. The new columns will be added to your existing tables

  3. A summary of applied changes will appear on the configuration summary

Step 7: Save the Datasource

  1. Review the updated configuration in the summary view

  2. Click Save to persist the changes

  3. Your agents now have access to the new columns

Example Scenario

Before Refresh:

  • You have a users table connected with columns: id, name, email

  • Custom descriptions explain what each column contains

After Adding Columns to Your Database:

  • Your DBA adds a tier column to the users table

Using Column Refresh:

  1. Click Refresh and wait for the analysis

  2. You see tier listed as a new column in the users table

  3. You customize the description for tier to be more specific to your needs

  4. You click Apply Changes and save

  5. Your agents now have access to these new columns without losing the existing users configuration

Troubleshooting

"Connection Failed" Error

  • Verify your database credentials are still valid

  • Check that the database server is accessible from elvex

  • Confirm that your service account hasn't been deleted or permissions haven't changed

"No Changes Detected"

  • This message appears when no new columns have been added since your last configuration

  • Your schema may not have changed, or the changes may be to existing columns (which aren't included in refresh)

Columns Not Appearing After Applying Changes

  • Ensure you clicked Save on the datasource configuration after applying changes

  • The changes are only persisted when you save the datasource

  • Refresh the page if changes don't appear immediately

Security Considerations

  • Column refresh uses existing credentials - it connects to your database using the same service account credentials you provided during initial setup

  • Read-only access required - elvex only reads schema information, it doesn't modify your database

  • Custom descriptions stay private - descriptions you add in elvex are stored within elvex and not sent to your database

  • Access control unchanged - adding new columns through refresh doesn't change who can access your datasource

Did this answer your question?