Skip to main content
MariaDB Logo
MariaDB

Tables sync from a MariaDB database

ReadyDatabase

Overview

The MariaDB connector indexes schema metadata, table contents from a MariaDB database so your AI assistant can answer questions over structured data alongside your other knowledge sources.
Looking for query execution from agents (run SQL on demand, no indexing)? Use the MariaDB Toolset instead. Connector = sync & search. Toolset = run actions.

What Gets Synced


Configuration Guide

Novaplan prepares your workspace. The optional local MariaDB steps below set up a database for testing, not Novaplan AI. A managed Novaplan connector can reach localhost only on its own host, so use a database address reachable from your workspace and confirm network access with Novaplan Support.
If you already have a MariaDB server, skip this step.

Option A: Docker (local testing only)

If you need a disposable test database, follow the official MariaDB container instructions and set a unique test password. For a host-only test, bind the published port to 127.0.0.1 as described in Docker’s port-publishing guide. A port published without a host address may be reachable on other network interfaces. This local test database is not automatically reachable from your Novaplan AI workspace.

Option B: Install locally

Install MariaDB from the official MariaDB downloads page and follow the installer for your OS. After install, start the server and note your host, port, username, and password.

Verify the connection

Enter your password when prompted. If you reach the MariaDB [(none)]> prompt, the server is ready.

Create a user for the connector

Create a dedicated read-only user for Novaplan AI. Run these as root (or any user with CREATE USER and GRANT privileges) against the target database:
The connector also reads schema metadata from information_schema, which is available to any authenticated user by default.
Replace novaplan_reader, a_strong_password, and test_db with your own values. Use 'novaplan_reader'@'localhost' instead of '%' if Novaplan AI connects from the same host as the database.
  1. In Novaplan AI, open Workspace Settings → Connectors.
  2. Find MariaDB and choose + Setup or Configure.
MariaDB connector card in Available connectors
  1. Fill in the connection details:
The local test_db and localhost in Step 1 are only for testing MariaDB on the same computer. For a managed Novaplan workspace, use the actual reachable database host and database name agreed with Novaplan and your database administrator.
MariaDB connector auth configuration
Sync filters select which tables are processed and limit the rows fetched from each selected table. The accessible connector still lists table names to populate the selector and run a sync. Excluding a table does not mean its name or other database metadata is never read. Use a database account with access only to the intended data when source-level isolation is required.
MariaDB sync filters
Use Max rows per table to keep initial syncs fast on large tables, or to cap the amount of data exposed to your assistant.
  1. Pick Scheduled or Manual sync.
  2. If scheduled, set the Sync interval (default: 60 minutes).
  3. Click Save to enable the connector.
MariaDB sync settings
The connector verifies the connection, then runs the initial sync. Watch the Indexing Progress to track completion.
MariaDB connector active and synced

FAQ

For read-only sync, SELECT on the target database is enough:
The connector also reads schema metadata from information_schema, which is available to any authenticated user by default.
Yes. Use a host and port reachable from your Novaplan AI workspace through the network path approved by your database administrator and Novaplan. A public database endpoint is unnecessary when a private connection is available. Make sure the database accepts connections from that path and the user has the required privileges.
Use Max rows per table in sync filters to cap how many rows are fetched per table, and use the Tables filter to only sync the tables you actually need.
  • Connector indexes your table and rows so they can be searched alongside your other knowledge.
  • Toolset lets agents run live SQL against MariaDB at query time without indexing.
You can use both together — the connector for fast retrieval and the toolset when an agent needs to run a fresh query.