Direct Database Connector

You have the option to connect your Xano instance’s PostgreSQL database directly with an external application or service. This can be useful if there is a platform for manipulating your database that you prefer to use over the Xano interface, creating custom backup and restore solutions, or even performing data analytics. Use care when accessing your database directly. This type of connection removes the normal checks and balances for data validity that using Xano directly provides. It is also instance-wide, and not isolated to a specific workspace/workspaces. Proceed with caution.

​

Accessing the Database Connector

You can access your connection details two different ways.

​

Through the Instance Selection screen

On your instance selection screen, click the⚙️ icon, and in the panel that opens, choose Database Connector. The panel that opens is split into two sections, Details and Settings. The Details panel allows you to retrieve the access information for a direct database connection. Database Public IP is the IP address you’ll use to connect to your instance database. Database Credentials provides both full access and read only credentials. Use the full access credentials appropriately and with caution only when you need write access; otherwise, we recommend using read only for safety. You can also regenerate these credentials from here if necessary. The Settings panel allows you to enable and use an allow list, to limit direct database connections to specific IP addresses.

​

From your Workspace

From anywhere in a workspace, click Connect this backend. Choose Database Connections from the left-hand menu, and you’ll be presented with access to your database IP, credentials, and IP allowlist. You can review the section above for more details on how these operate.

​

Establishing a Direct Database Connection

You can use any application you’d like that is capable of connecting to a PostgreSQL database. In this example, we’ll be using Navicat. Select ‘Connection’ in the top-left, and fill in your credentials and the IP received from Xano. Click ‘Save’ to save the connection. We can now navigate the PostgreSQL database from Xano using Navicat. We can even add / update data, run queries, etc…

​

Table Formats

As of our 1.68 release (5/27/25), all new workspaces will default to the standard SQL column format for tables. For all workspaces created prior to that, read below. Your tables can be created using one of two formats:

• JSONB format
  • This creates your tables with two columns:
    • id - the ID of the record
    • jsonb - contains a JSON representation of the entire record
• Standard SQL format
  • This creates a more standard table layout. Instead of a jsonb column, each column is written separately.

If you are using the Direct Database Connector, Standard SQL format is usually recommended.

​

Converting Tables from JSONB to standard SQL

​

Custom SQL Table Names

From your Workspace settings, you can enable Custom SQL Table Names. By default, Xano assigns each table a SQL name in the format mvpw_ (e.g., mvpw1_3). This identifier works for direct access, but can be difficult to read or use with direct queries and database tools. You can replace this with a custom SQL name to make queries more intuitive and improve compatibility with external connectors. If you change a table’s SQL name, be sure to update any queries that reference the old name to avoid breaking functionality. Once you’ve enabled Custom SQL Table Names, head to any database table’s settings, and click Manage next to SQL Table Name.

• Leave the SQL Table Name field blank to use Xano’s default SQL table name, which follows the format mvpw<workspaceID>_<tableID> (e.g., mvpw1_3).
• SQL table names must be globally unique across all workspaces. Hint: Use the Custom Prefix to ensure uniqueness across workspaces.
• Datasources automatically add a suffix based on their environment. For example, users becomes users_test in the test datasource.* To reuse the same base name across workspaces, use a workspace-specific prefix (e.g., projA_users, projB_users).

​

What are these extra tables I see when connecting directly?

Xano maintains several database tables behind the scenes to operate your instances, workspace, and application. It should generally not be considered safe to directly modify these tables at any time, and only target tables you’ve created as a part of your application. Some of these tables can safely be included in TRUNCATE operations if you wish to perform maintenance outside of the Xano interface. These tables are:

• mvp_request — contains API request history
• mvp_function_history — contains custom function request history
• mvp_task_history — contains background task run history
• mvp_tool_history — contains API tool request history
• mvp_trigger_history — contains history of trigger executions
• mvp_middleware_history — contains history of middleware executions