-
Notifications
You must be signed in to change notification settings - Fork 411
Database driver XML
Note: This feature is available in Enterprise, AWS, Team editions only.
This guide provides instructions on how to set up and use XML files with CloudBeaver. The XML driver supports standard XML files, including both attribute-based and nested element-based structures. You can retrieve data and apply filters, sorting, and other operations, even combining data from multiple files.
Important: When using the XML driver, all connected XML files are read-only. To make changes, you need to update the original files outside CloudBeaver.
This section describes two ways to set up a connection: opening a file from Cloud Storage or creating a connection using the wizard.
Note: The connection from Cloud Storage is temporary and will be removed when the session ends.
You can open files directly from your Cloud Storage. Open Cloud Storage, find the file you need, and double-click it to create a connection. The connection will appear in the File databases folder in Database Navigator.
You'll need to be logged in using the Identity Provider associated with your Cloud Storage.
To create a connection in CloudBeaver, use the new connection wizard, select the XML driver, and fill the following fields:
Field | Description | Options |
---|---|---|
Configuration | Choose how to specify the connection details. | - Manual: Enter the database path manually. - URL: Provide a connection URL. |
Database | Enter the file/folder path. | Use the appropriate format for your cloud provider. For instance: s3://AWS/files/path/example/
|
Connection name | Enter a custom name for your connection. | Defaults to XML@localhost . |
Project | Select the project where this connection belongs. | Default: Private. |
Description | (Optional) Add details about this connection. | |
Keep alive (in seconds) | Set how long the connection stays active. | Default: 0 (no timeout). |
Auto commit | Enable automatic transaction commits. See more details on Auto and Manual commit modes. | Enabled by default. |
Read-only connection | Restrict the connection to read-only mode. | Optional checkbox. |
Tip: When using the folder path in the Database field, CloudBeaver scans the directory up to two levels deep for supported files. If the folder contains multiple files, CloudBeaver organizes them into schemas based on their directory structure. For more information, see folder structure.
The XML driver supports the full range of SQL queries:
-
Simple queries (e.g.,
SELECT * FROM table
): Data is read directly from the XML file. -
Complex queries (e.g., using
WHERE
,JOIN
,ORDER BY
,GROUP BY
): When a complex query is executed for the first time, the driver imports the entire XML file into an internal database to enable advanced SQL functions. Subsequent queries run faster because the data is already imported into internal database.
Note: If you want to join data from different files, they must be opened in the same connection. To do this, use a folder path instead of a single file when creating the connection.
When working with a folder containing multiple XML files, CloudBeaver organizes them as follows:
Folder structure | Schema in CloudBeaver |
---|---|
Root files |
Default schema |
Subfolder files | Schema named after the subfolder |
Files in deeper folders | Ignored |
If your folder looks like this:
Data/
├── employees.xml
├── sales.xml
└── Reports/
└── monthly.xml
└── yearly.xml
CloudBeaver will create:
-
Default
schema:employees
,sales
-
Reports
schema:monthly
,yearly
Tip: To focus on specific files, consider selecting individual files or folders when configuring the connection.
When you execute a complex query (such as WHERE
, JOIN
, GROUP BY
, or ORDER BY
.), on an XML file for the first
time, the XML driver processes the data by importing it into a temporary internal SQLite database.
This internal database stores data temporarily on the server during your session and is cleared when session ends.
CloudBeaver provides additional features compatible with XML driver, but not exclusive to it:
Category | Feature |
---|---|
Data Export | Data Export |
Data Visualization | Visual Query Builder |
Charts |
For more details on driver properties, see File-based driver properties.
-
Administration
- Server configuration
- Create Connection
- Connection Templates Management
- Access Management
-
Authentication methods
-
Local Access Authentication
- Anonymous Access Configuration
- Reverse proxy header authentication
- LDAP
-
Single Sign On
-
SAML
-
OpenID
-
AWS OpenID
-
AWS SAML
-
AWS IAM
-
AWS OpenId via Okta
-
Snowflake SSO
-
Okta OpenId
-
Cognito OpenId
-
JWT authentication
-
Kerberos authentication
-
NTLM
-
Microsoft Entra ID authentication
-
Google authentication
-
Local Access Authentication
- Database authentication methods
- Network configuration settings
- User credentials storage
- Cloud databases configuration
-
Query Manager
-
Drivers Management
-
Features
- Server configuration
-
Domain manager
- Product configuration parameters
- Command line parameters
- Local Preferences
- API
- Deployment options
- Additional setup and management