Execute SQL File

DBCode allows you to run SQL script files against a database or supported server connection, making it easy to execute multiple statements, database migrations, or setup scripts without having to copy and paste the content into the SQL editor.

Overview

The Execute SQL File feature provides a convenient way to:

• Run database migration scripts
• Execute setup or seed scripts
• Apply database schema changes
• Import data using SQL statements
• Run complex multi-statement scripts

Using Execute SQL File

Execute Against a Database

1. Open the Database Explorer view in the sidebar
2. Connect to and expand your server connection
3. Right-click the target database
4. Select Execute SQL File
5. Browse to and select your .sql file

DBCode executes the file against the selected database.

Execute From a Connection

If Execute SQL File appears when you right-click a connection, you can run a bootstrap script without first selecting a database:

1. Open the Database Explorer view in the sidebar
2. Right-click the server connection
3. Select Execute SQL File
4. Browse to and select your .sql file

DBCode runs the file through the selected connection. If the saved connection specifies a database, the script starts there. Otherwise, the driver or server determines the initial database for the login; on some systems, no database is selected.

Important: DBCode never removes a saved database setting or retries against another database. If the saved database does not exist, the connection fails before the script starts. For bootstrap scripts, leave the database unset or configure an existing database from which the script can create the new one.

View Results

After execution begins, the Results panel opens automatically. It shows statement results in order and reports parsing or execution errors.

Best Practices

SQL File Structure

• Include proper statement terminators (semicolons) between statements
• Consider adding comments to document complex operations
• For large operations, include transaction boundaries (BEGIN TRANSACTION/COMMIT)
• Use consistent formatting for better readability

Error Handling

• Check the Results panel for any errors after execution
• Consider executing critical scripts in transactions for rollback capability
• For complex scripts, test on development environments before production

Performance Considerations

• Large SQL files may take time to execute
• Monitor the Results panel for progress
• Consider breaking very large scripts into smaller, logical files

Common Use Cases

Database Migration

-- Example migration script
CREATE TABLE customers (
    id INT PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    email VARCHAR(100) UNIQUE
);

CREATE INDEX idx_customer_email ON customers(email);

INSERT INTO customers VALUES (1, 'Acme Corp', 'contact@acme.com');

Schema Updates

-- Example schema update script
ALTER TABLE products ADD COLUMN last_updated TIMESTAMP;
UPDATE products SET last_updated = CURRENT_TIMESTAMP;
CREATE INDEX idx_last_updated ON products(last_updated);

Data Cleanup

-- Example cleanup script
DELETE FROM audit_logs WHERE created_at < DATEADD(month, -6, CURRENT_DATE);
VACUUM audit_logs;

Limitations

• Very large files may take time to process
• The Results panel will show output for all statements, which can be extensive for large scripts
• Some database-specific features might have varying behavior

Alternatives

If you prefer an interactive approach for complex scripts, consider:

• Using DBCode’s SQL Editor for step-by-step execution
• Breaking down large scripts into DBCode Notebooks with documentation
• Using database-specific command-line tools for certain operations

With Execute SQL File, you can quickly run existing SQL scripts directly from your filesystem without having to manually transfer their content to the SQL editor.