Xano Documentation
  • πŸ‘‹Welcome to Xano!
  • 🌟Frequently Asked Questions
  • πŸ”Security & Compliance (Trust Center)
  • πŸ™Feature Requests
  • πŸ’”Known Issues
  • Before You Begin
    • Using These Docs
    • Where should I start?
    • Set Up a Free Xano Account
    • Key Concepts
    • The Development Life Cycle
    • Navigating Xano
    • Plans & Pricing
  • The Database
    • Designing your Database
    • Database Basics
      • Using the Xano Database
      • Field Types
      • Relationships
      • Database Views
      • Export and Sharing
      • Data Sources
    • Migrating your Data
      • Airtable to Xano
      • Supabase to Xano
      • CSV Import & Export
    • Database Performance and Maintenance
      • Storage
      • Indexing
      • Maintenance
      • Schema Versioning
  • πŸ› οΈThe Function Stack
    • Building with Visual Development
      • APIs
        • Swagger (OpenAPI Documentation)
      • Custom Functions
        • Async Functions
      • Background Tasks
      • Triggers
      • Middleware
      • Configuring Expressions
      • Working with Data
    • Functions
      • AI Tools
      • Database Requests
        • Query All Records
          • External Filtering Examples
        • Get Record
        • Add Record
        • Edit Record
        • Add or Edit Record
        • Patch Record
        • Delete Record
        • Bulk Operations
        • Database Transaction
        • External Database Query
        • Direct Database Query
        • Get Database Schema
      • Data Manipulation
        • Create Variable
        • Update Variable
        • Conditional
        • Switch
        • Loops
        • Math
        • Arrays
        • Objects
        • Text
      • Security
      • APIs & Lambdas
        • Realtime Functions
        • External API Request
        • Lambda Functions
      • Data Caching (Redis)
      • Custom Functions
      • Utility Functions
      • File Storage
      • Cloud Services
    • Filters
      • Manipulation
      • Math
      • Timestamp
      • Text
      • Array
      • Transform
      • Conversion
      • Comparison
      • Security
    • Data Types
      • Text
      • Expression
      • Array
      • Object
      • Integer
      • Decimal
      • Boolean
      • Timestamp
      • Null
    • Environment Variables
    • Additional Features
      • Response Caching
  • Testing and Debugging
    • Testing and Debugging Function Stacks
    • Unit Tests
    • Test Suites
  • CI/CD
  • File Storage
    • File Storage in Xano
    • Private File Storage
  • Realtime
    • Realtime in Xano
    • Channel Permissions
    • Realtime in Webflow
  • Maintenance, Monitoring, and Logging
    • Statement Explorer
    • Request History
    • Instance Dashboard
      • Memory Usage
  • Building Backend Features
    • User Authentication & User Data
      • Separating User Data
      • Restricting Access (RBAC)
      • OAuth (SSO)
    • Webhooks
    • Messaging
    • Emails
    • Custom Report Generation
    • Fuzzy Search
    • Chatbots
  • Xano Features
    • Snippets
    • Instance Settings
      • Release Track Preferences
      • Static IP (Outgoing)
      • Change Server Region
      • Direct Database Connector
      • Backup and Restore
      • Security Policy
    • Workspace Settings
    • Advanced Back-end Features
      • Xano Link
      • Developer API (Deprecated)
    • Metadata API
      • Master Metadata API
      • Tables and Schema
      • Content
      • Search
      • File
      • Request History
      • Workspace Import and Export
      • Token Scopes Reference
  • Build With AI
    • Building a Backend Using AI
    • Get Started Assistant
    • AI Database Assistant
    • AI Lambda Assistant
    • AI SQL Assistant
    • API Request Assistant
    • Template Engine
    • Streaming APIs
  • Using AI Builders with Xano
  • Build For AI
    • MCP Builder
      • Connecting Clients
      • MCP Functions
    • Xano MCP Server
  • Xano Transform
    • Using Xano Transform
  • Xano Actions
    • What are Actions?
    • Browse Actions
  • Team Collaboration
    • Realtime Collaboration
    • Managing Team Members
    • Branching & Merging
    • Role-based Access Control (RBAC)
  • Agencies
    • Xano for Agencies
    • Agency Features
      • Agency Dashboard
      • Client Invite
      • Transfer Ownership
      • Agency Profile
      • Commission
      • Private Marketplace
  • Enterprise
    • Xano for Enterprise
    • Enterprise Features
      • Microservices
        • Ollama
          • Choosing a Model
      • Tenant Center
      • Compliance Center
      • Security Policy
      • Instance Activity
      • Deployment
      • RBAC (Role-based Access Control)
      • Xano Link
  • Your Xano Account
    • Account Page
    • Billing
    • Referrals & Commissions
  • Troubleshooting & Support
    • Error Reference
    • Troubleshooting Performance
      • When a single workflow feels slow
      • When everything feels slow
      • RAM Usage
      • Function Stack Performance
    • Getting Help
      • Granting Access
      • Community Code of Conduct
      • Community Content Modification Policy
  • Special Pricing
    • Students & Education
    • Non-Profits
  • Security
    • Best Practices
Powered by GitBook
On this page

Was this helpful?

  1. Xano Features
  2. Instance Settings

Direct Database Connector

Establish a direct connection to your instance's PostgreSQL database

Last updated 23 days ago

Was this helpful?

Note

Direct Database Connector is available as a paid add-on. Please visit your to add this to your plan.

Database Connector is a premium add-on that is available for Launch and Scale plans. Please visit your Billing page for the most up-to-date pricing for this additional feature.

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 a significant portion of normal checks and balances for data validity that using Xano directly provides.

Proceed with caution.

How to Access the Database Connector

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.

Details allows you to retrieve the access information for a direct database connection.

Settings allows you to enable and use an allow list, to limit direct database connections to specific IP addresses.

  1. Get your database's public IP

  2. Get your database credentials

  3. Settings Panel

  4. Add an IP address to your allow list

Clicking both of the "Get" buttons will provide us with the database IP and two sets of credentials, full-access and read-only.

From this panel, you can also revoke and re-generate your database credentials, should the need arise.

Establishing a Database Connection (Example)

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...

Billing page

Table Format

Table Formats - Only relevant for direct database connections

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.

When to Convert to Standard SQL Format:

  • You need direct database connections with third-party tools that aren't friendly to JSONB format, such as Tableau or PowerBI

  • You want faster performance for non-indexed queries

  • You're frequently adding new fields (faster column additions)

  • You plan to use SQL analytics tools or run complex reports directly against your database

When to Keep JSONB Format:

  • You're satisfied with current performance

  • You don't need direct database connections

Converting Tables from JSONB to standard SQL

This change is permanent. Most users will not need to adjust these settings, and they only impact your experience if you are connecting to your database directly via third-party tools.

Using standard SQL does not mean you can't use JSONB β€” you have the ability to mix and match table types, if you prefer. You can also still use JSON fields on any table type for more complex, dynamic field structure.

1

From your workspace dashboard, click the settings icon in the upper-right corner, and click Settings.

2

Scroll down to the Database Preferences section, and check the option to 'Use standard SQL columns for new tables'

3

Convert your table(s) from your workspace settings, or the settings of any table.

From the migration panel, select any of the tables you'd like to convert, and confirm your choices. The migration will begin immediately.

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).

This setting must be enabled before you can convert existing tables to the new format.