Skip to content

SQL Server

EPSIO BETA AVAILABILITY

At this time, Epsio for SQL Server is only available to beta users.
To get early access, contact us at support@epsio.io

This guide will walk you through the process of deploying Epsio for SQL Server.

Before you begin

Before proceeding with the deployment guide, ensure that you have the following:

  • A VM instance to run epsio on with:
    • Network access to your SQL Server.
    • docker, docker compose plugin and zip installed on it.
  • SQL Server version 2012 or above
  • Your database host's IP (e.g., 1.2.3.4) or domain (your.server.com)
  • Your database's port (usually 1433)

1. Launch Epsio in your VM

After you sign up, a wizard will appear and walk you through the stages of deployment.

Choose the architecture of your VM:

Launch Epsio

Run the displayed command in your VM:

Run command

Wait until Epsio is successfully deployed, and then proceed to the next step.


2. Connect Epsio to your database

The next step will be to configure your database and connect it to Epsio.

Open a connection to your database and follow the steps below.

Create a database user for Epsio's exclusive use:

USE [<database>];
CREATE LOGIN epsio_user WITH PASSWORD = '<password>';
CREATE USER epsio_user FOR LOGIN epsio_user;

Create a schema for Epsio

CREATE SCHEMA epsio;
GRANT SELECT on SCHEMA::epsio to epsio_user;
ALTER AUTHORIZATION ON SCHEMA::epsio TO epsio_user;
GRANT CREATE TABLE to epsio_user;

Grant user permissions
Grant the epsio_user read-only access to all tables in your schema by running the following commands:

GRANT SELECT on SCHEMA::<schema> to epsio_user;

If you plan to access schemas for multiple schemas, you'll need to run these commands for each schema.
Replace <schema> with the name of your schema.

Enter the Hostname / IP of the VM you deployed Epsio in:

Connect to database

Enter the credentials of the epsio user you've just created in the wizard and click connect:
You will also need to provide the hostname (or IP address), port and database name.

Connect to database

After connection, Epsio will check that your database is configured correctly and will create the functions under the epsio schema.
Continue to the next step to configure CDC.


3. Configure CDC

3.1 Enable CDC at database level

Enable CDC at the database level:

USE [<database>];
EXEC sys.sp_cdc_enable_db;
Enable CDC for all specific needed tables:
EXEC sys.sp_cdc_enable_table  
@source_schema = [<schema>],
@source_name   = [<table>],
@role_name     = 'epsio_user';

3.2 Validate CDC

Once finished, click on the "Validate Configuration" and Epsio will verify that CDC is set up correctly.

Congratulations! You've successfully enabled CDC in your database.


Once Epsio successfully connects to your database, you'll be redirected to the Epsio dashboard.

You are set to go and can create your first view. Visit the create_view for further details.