Create Channel and Configure Database Tables

A Database Channel in RAGFish is used to connect the RAG system directly to a supported database and make selected database tables available as a knowledge source.

Unlike a Document Channel, where users upload files, a Database Channel connects to an existing database using database connection details.

Once the connection is successfully established, RAGFish displays the available tables from the selected database. Users can then select the required tables and configure them.

After the required tables are successfully configured, the Database Channel is ready to be mapped and used according to the configured access and assistant setup.

Step 1: Create a Channel

Navigate to the Channels page in RAGFish.

Click the Create Channel option.

The channel creation page will be displayed.

At this stage, you need to provide the basic information required to create the channel.

Step 2: Enter Basic Channel Details

Enter the required basic details for the channel.

The channel information helps identify the purpose of the database connection.

For example:

Channel Name:

Customer Database

You can use a meaningful name based on the database or business purpose.

Examples

1. Customer Database
2. Sales Database
3. Employee Database

A meaningful channel name makes it easier to identify the database source when multiple channels are available.

Step 3: Select Database Channel Type

Under Channel Type, select:

Database

After selecting the Database channel type, RAGFish displays the supported database options.

The available options in your current RAGFish flow are:

1.MySQL

2.PostgreSQL

These options allow you to specify which type of database you want to connect to.

Step 4: Select the Database Type

Select the database that you want to connect to.

Option 1 – MySQL

Select MySQL when the database you want to connect to is a MySQL database.

Option 2 – PostgreSQL

Select PostgreSQL when the database you want to connect to is a PostgreSQL database.

For example:

Database Type

○ MySQL

● PostgreSQL

Select the required database type and click Next.

Step 5: Enter Database Connection Details

After selecting the database type and clicking Next, RAGFish displays the database connection configuration fields.

Enter the connection details required to establish communication with the selected database.

The connection details include:

1. Server Name
2. Database
3. IP Address
4. Port Name
5. Username
6. Password

These details allow RAGFish to identify and authenticate with the database.

Server Name

Enter the name of the database server.

The server name identifies the server where the database is hosted.

Example

Server Name:CustomerDB-Server

Use the server name provided by your database administrator or infrastructure team.

Database

Enter the name of the database that you want RAGFish to connect to.

Example

Database:CustomerDB

This identifies the specific database from which the tables will be retrieved.

IP Address

Enter the IP address of the database server.

Example

IP Address: 192.168.1.100

The IP address should point to the server where the selected database is hosted.

Port Name

Enter the port used by the selected database connection.

The port depends on the database configuration.

For example:

Port:3306

or:

Port: 5432

The appropriate port should be provided by your database administrator or database configuration.

Username

Enter the username required to authenticate with the database.

Example

Username: ragfish_user

The username should have the required permissions to access the database and the tables that need to be configured.

Password

Enter the password associated with the database username.

Example

Password: ********

The password is used to authenticate the database connection.

Step 6: Create the Database Channel

After entering all required database connection details, click Create Channel.

RAGFish uses the provided information to establish a connection with the selected database.

If the connection is successful, the Database Channel is created and connected to the configured database.

Step 7:View Available Database Tables

After the database connection is successfully established, RAGFish displays the tables available in the connected database.

For example, suppose the connected database is:

CustomerDB

It may contain tables such as:

CustomerDB
│
├── Customers
├── Orders
├── Products
├── Payments
└── Addresses

These tables are displayed under the created Database Channel.

This allows the user to select which database tables should be configured for use.

Step 8: Select the Required Tables

Not every table in a database may be required for the RAG use case.

Therefore, select only the tables that you want to configure.

For example:

☑ Customers

☑ Orders

☐ Payments

☐ Addresses

In this example, the Customers and Orders tables have been selected, while Payments and Addresses have not been selected.

You can select the tables according to the purpose of your AI assistant or knowledge requirement.

Step 9 : Click Configure

After selecting the required tables, click the Configure option.

RAGFish processes the selected tables and configures them for use within the Database Channel.

The configuration associates the selected database tables with the channel.