Exasol

https://docs.exasol.com/db/latest/
Admin
Exasol is an in-memory SQL database designed for high-performance analytics and data processing with...
Tokens:461,324
Snippets:6,535
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Monitor Installation Logs

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/deploy_on_hosts.htm

Connect to a node via SSH and use this command to monitor the installation process in real-time. This is helpful for diagnosing issues during the setup.

```bash
sudo journalctl -f
```

--------------------------------

### Example Installation Error

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/deploy_on_hosts.htm

This example shows a typical error message encountered during package extraction. It indicates a failure to create a directory, which needs to be resolved before retrying the installation.

```text
INFO[2023-09-02 09:22:44]: Extracting packages...
cp: cannot create regular file '/var/lib/ccc/bin/': No such file or directory
```

--------------------------------

### Exasol TIMING Command Example

Source: https://docs.exasol.com/db/latest/connect_exasol/sql_clients/exaplus_cli/exaplus_commands/timing.htm

Demonstrates starting a named timer, showing all active timers, and then stopping the named timer.

```sql
timing start my_timing;  
timing show;  
timing stop my_timing;
```

--------------------------------

### Exasol Installation Completion Message

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/deploy_on_hosts.htm

This example shows a confirmation message after the Exasol installation has successfully started on remote hosts. It indicates that finalization is in progress and provides information on how to monitor and connect after completion.

```text
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  
  The final steps of the Exasol installation procedure were successfully  
  started on remote hosts now.  
  It will take yet some time to complete (several minutes).  
  After the installation is finished, you can connect to the Database or COS.  
  
  During the installation, you can login to the hosts via SSH,  
  and watch the process using:  
  
    sudo journalctl -f  
  
  After the installation finished, you can connect to COS using:  
  
    ssh -p 20002 root@$IP  
  
  IP addresses of the systems:  
  
    * 203.0.113.11  
    * 203.0.113.12  
    * 203.0.113.13  
    * 203.0.113.14  
  
  Exasol version: 2025.1.0  
  Exasol package: @exasol-2025.1.0  
  
  Happy Exasolling!  
  
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
```

--------------------------------

### Start Exasol AI Lab

Source: https://docs.exasol.com/db/latest/ai/ai_application/extract-insights-from-text.htm

Launch the Exasol AI Lab container to access pre-installed Text AI tools and example notebooks.

```bash
docker run --publish 0.0.0.0:49494:49494 exasol/ai-lab
```

--------------------------------

### Initialize Standby Database

Source: https://docs.exasol.com/db/latest/administration/on-premise/sddc/sddc_installation.htm

Starts and stops the standby database to perform initial setup.

```bash
confd_client db_start db_name: PROD_DR  
confd_client db_stop db_name: PROD_DR
```

--------------------------------

### Run Exasol STACKIT installation

Source: https://docs.exasol.com/db/latest/get_started/exasol_personal_stackit_setup.htm

Execute the installation command using the project UUID and optional region parameters.

```bash
exasol install stackit --project-id "<your-project-uuid>"  
exasol install stackit --region eu02 --project-id "<your-project-uuid>"
```

--------------------------------

### Single-line command examples

Source: https://docs.exasol.com/db/latest/administration/on-premise/c4/c4_install.htm

Practical examples of executing commands with options or scripts.

```bash
c4 connect -i c3275f84 -s host -- 'ls -t'
```

```bash
c4 connect -i c3275f84 -s cos -- 'confd_client db_stop db_name: MY_DATABASE'
```

--------------------------------

### Parameter Format Examples

Source: https://docs.exasol.com/db/latest/administration/on-premise/c4/c4_parameters.htm

Examples of how parameters are formatted across different configuration methods.

```text
CCC_PLAY_DATABASE_NAME=my_db
```

```yaml
play:  
 database_name: my_db
```

```bash
c4 play --ccc-play-database-name my_db ...
```

```bash
c4 play --database-name my_db --db-password j8IUgef7_IJz9 ...
```

--------------------------------

### Start Exasol Services

Source: https://docs.exasol.com/db/latest/administration/on-premise/nodes/stop_start_nodes.htm

Manually start the c4 and c4_cloud_command services if they did not start automatically.

```bash
sudo systemctl start c4  
sudo systemctl start c4_cloud_command
```

--------------------------------

### Exasol Installation Confirmation and Details

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/deploy_on_hosts.htm

This output displays the parameters that will be used for the Exasol installation and prompts for confirmation. It also provides details about the installation process, including IP addresses, version, and SSH credentials.

```text
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
  
  Exasol installation procedure is about to be started.  
  During this procedure, Exasol software will be installed to remote hosts.  
  It will take some time (several minutes).  
  The installation is finished when every node reaches stage 'd' (see 'c4 ps').  
  After the installation is finished, you can connect to the Database or COS.  
  
  During the installation, you can login to the hosts via SSH,  
  and watch the process using:  
  
    sudo journalctl -f  
  
  After the installation finished, you can connect to COS using:  
  
    ssh -p 20002 root@$IP  
  
  IP addresses of the systems:  
  
    * 203.0.113.11  
    * 203.0.113.12  
    * 203.0.113.13  
    * 203.0.113.14  
  
  Exasol version: 2025.1.0  
  Exasol package: @exasol-2025.1.0  
  SSH username  : exasol  
  SSH keyfile   : id_rsa  
  User password : exasol123  
  Data disk(s)  : /dev/mapper/exasol_disk_1,/dev/mapper/exasol_disk_2  
  
  Press ENTER to proceed or Control+C to cancel the installation procedure.  
  
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
```

--------------------------------

### EXAplus settings output example

Source: https://docs.exasol.com/db/latest/connect_exasol/sql_clients/exaplus_cli/exaplus_commands/show.htm

Example output showing various EXAplus settings and their current values. This helps understand the configuration parameters available.

```text
AUTOCOMMIT = "ON"  
AUTOCOMPLETION = "ON"  
COLSEPARATOR = " "  
DEFINE = "&"  
ENCODING = "UTF-8"  
ESCAPE = "OFF"FEEDBACK = "ON"HEADING = "ON"LINESIZE = "200"NULL = "null"NUMFORMAT = "null"  
PAGESIZE = "UNLIMITED"  
SPOOL ROW SEPARATOR = "AUTO"  
TIME = "OFF"  
TIMING = "OFF"  
TRUNCATE HEADING = "ON"  
VERBOSE = "ON"
```

--------------------------------

### Start Database via ConfD

Source: https://docs.exasol.com/db/latest/administration/on-premise/backup_restore/virtual_access_on_backup.htm

Start a database instance using the db_start job.

```bash
confd_client db_start db_name: MY_DATABASE
```

--------------------------------

### Start Active Database

Source: https://docs.exasol.com/db/latest/administration/on-premise/sddc/sddc_installation.htm

Starts the specified active database instance.

```bash
confd_client db_start db_name: PROD
```

--------------------------------

### Alter Schema Examples

Source: https://docs.exasol.com/db/latest/sql/alter_schema.htm

Examples demonstrating how to change schema ownership, set raw size limits, and update virtual schema configurations.

```sql
ALTER SCHEMA s1 CHANGE OWNER user1;  
ALTER SCHEMA s1 CHANGE OWNER role1;  
ALTER SCHEMA s1 SET RAW_SIZE_LIMIT = 128*1024*1024;  
ALTER VIRTUAL SCHEMA s2  
  SET CONNECTION_STRING = 'jdbc:hive2://localhost:10000/default';  
ALTER VIRTUAL SCHEMA s2 REFRESH;
```

--------------------------------

### Exasol JDBC URL Connection Examples

Source: https://docs.exasol.com/db/latest/connect_exasol/drivers/jdbc.htm

Various examples of connection strings using different host configurations and fingerprints.

```text
jdbc:exa:myhost/72975B4D331DEEB44FA41FB858A5417E163151BBFB45376574706800A8DCCE30:8563
```

```text
jdbc:exa:myhost/72975B4D331DEEB44FA41FB858A5417E163151BBFB45376574706800A8DCCE30:8563,myhost2:8564
```

```text
jdbc:exa:myhost1..4/72975B4D331DEEB44FA41FB858A5417E163151BBFB45376574706800A8DCCE30:8563 
```

```text
jdbc:exa:192.168.6.11..14/72975B4D331DEEB44FA41FB858A5417E163151BBFB45376574706800A8DCCE30:8563 
```

--------------------------------

### ODBC Connection String Examples

Source: https://docs.exasol.com/db/latest/connect_exasol/drivers/odbc/using_odbc.htm

Examples of DSN and DSN-less connection strings for connecting to an Exasol database.

```text
DSN=exa_test;UID=sys;EXASCHEMA=MY_SCHEMA;PWD=<my_password>
```

```text
DRIVER={Exasol Driver};EXAHOST=192.168.6.11..14/<fingerprint>:8563;UID=sys;PWD=<my_password>
```

--------------------------------

### Run Exasol Install Command

Source: https://docs.exasol.com/db/latest/get_started/exasol_personal_administration.htm

Execute the installation command for your specific cloud provider or local environment.

```bash
exasol install aws                         # Amazon Web Services  
exasol install azure --location <region>   # Microsoft Azure  
exasol install exoscale [--zone <zone>]    # Exoscale  
exasol install stackit                     # STACKIT  
exasol install local                       # local system, macOS
```

--------------------------------

### Install Exasol Personal

Source: https://docs.exasol.com/db/latest/get_started/exasol_personal_administration.htm

Commands to initiate the installation of Exasol Personal on supported cloud providers or a local system.

```bash
exasol install aws        # Amazon Web Services
```

```bash
exasol install azure      # Microsoft Azure
```

```bash
exasol install exoscale   # Exoscale
```

```bash
exasol install stackit    # STACKIT
```

```bash
exasol install local      # local system, macOS
```

--------------------------------

### Shell Configuration File Example

Source: https://docs.exasol.com/db/latest/administration/on-premise/c4/c4_parameters.htm

Example of a configuration file using shell format located at $HOME/.ccc/config.

```bash
$ cat $HOME/.ccc/config  
CCC_USER_EMAIL=firstname.lastname@exasol.com  
CCC_HOST_EXTERNAL_ADDRS="198.51.100.11 198.51.100.12 198.51.100.13"  
CCC_HOST_DATADISK=/dev/mapper/exasol_disk_1,/dev/mapper/exasol_disk_2  
CCC_PLAY_WORKING_COPY=@exasol-8.22.0
```

--------------------------------

### Example calculation for virtual instance DB RAM

Source: https://docs.exasol.com/db/latest/administration/on-premise/backup_restore/virtual_access_on_backup.htm

Calculation example for a database running on 4 active nodes.

```text
4 * 4 GiB = 16 GiB DB RAM
```

--------------------------------

### Start Database Clusters (AWS Native)

Source: https://docs.exasol.com/db/latest/administration/on-premise/manage_database/start_db.htm

Commands for starting specific database clusters in AWS native deployments.

```bash
confd_client db_start db_name: MY_DATABASE  
# or  
confd_client db_start db_name: MY_DATABASE cluster: +all
```

```bash
confd_client db_start db_name: MY_DATABASE cluster: MAIN  
# or  
confd_client db_start db_name: MY_DATABASE cluster: MY_DATABASE
```

```bash
confd_client db_start db_name: MY_DATABASE cluster: WORKER1
```

--------------------------------

### Run Exasol Installation with Default Config

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/deploy_on_hosts.htm

Execute the Exasol installation on the host using the default configuration file located at './config'.

```bash
./c4 host play -i config
```

--------------------------------

### Run Exasol Installation with Custom Config

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/deploy_on_hosts.htm

Execute the Exasol installation on the host, specifying a custom configuration file path using the -i option.

```bash
./c4 host play -i /path_to_config_file/myconfig
```

--------------------------------

### CREATE TABLE Examples

Source: https://docs.exasol.com/db/latest/sql/create_table.htm

Demonstrates various ways to create tables, including column definitions, subqueries, LIKE clauses, and partitioning.

```sql
CREATE TABLE t1 (a VARCHAR(20),  
		   b DECIMAL(24,4) NOT NULL,  
		   c DECIMAL DEFAULT 122,  
		   d DOUBLE,  
		   e TIMESTAMP DEFAULT CURRENT_TIMESTAMP,  
		   f BOOL);  
		   
CREATE TABLE t2 AS SELECT * FROM t1;  
  
CREATE OR REPLACE TABLE t2 AS SELECT a,b,c+1 AS c FROM t1;  
  
CREATE TABLE t3 AS SELECT count(*) AS my_count FROM t1 WITH NO DATA;  
  
CREATE TABLE t4 LIKE t1;  
  
CREATE TABLE t5 (id int IDENTITY PRIMARY KEY,  
		   LIKE t1 INCLUDING DEFAULTS,  
		   g DOUBLE,  
		   DISTRIBUTE BY a,b);  
  
CREATE TABLE t6 (order_id INT,  
		   order_price DOUBLE,  
		   order_date DATE,  
		   country VARCHAR(40),  
		   PARTITION BY order_date);  
  
SELECT * INTO TABLE t7 FROM t1;  
  
CREATE OR REPLACE TABLE t8 (ref_id int CONSTRAINT FK_T5 REFERENCES t5 (id) DISABLE, b VARCHAR(20));
```

--------------------------------

### Connect to Exasol with Java

Source: https://docs.exasol.com/db/latest/connect_exasol/drivers/jdbc.htm

A complete Java example demonstrating how to load the driver, establish a connection, and query the database.

```java
import java.sql.*;  
import com.exasol.jdbc.*;  
  
public class jdbcsample  
{  
    public static void main(String[] args)  
    {  
        try { Class.forName("com.exasol.jdbc.EXADriver");  
    } catch (ClassNotFoundException e) {   
            e.printStackTrace();  
    }  
    Connection con=null;   
    Statement stmt=null;   
    try {  
        con = DriverManager.getConnection(   
            "jdbc:exa:192.168.6.11..14:8563;schema=SYS",  
            "sys",   
            "123456789"  
            );  
        stmt = con.createStatement();  
        ResultSet rs = stmt.executeQuery("SELECT * FROM CAT");   
        System.out.println("Schema SYS contains:");   
        while(rs.next())  
        {  
            String str1 = rs.getString("TABLE_NAME");   
            String str2 = rs.getString("TABLE_TYPE");   
            System.out.println(str1 + ", " + str2);  
        }  
    } catch (SQLException e) {   
        e.printStackTrace();  
    } finally {  
        try {stmt.close();} catch (Exception e) {e.printStackTrace();}   
        try {con.close();} catch (Exception e) {e.printStackTrace();}  
        }  
    }  
}  
```

--------------------------------

### SQL INSERT Function Example

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/insert.htm

Demonstrates the usage of the INSERT function to replace substrings within strings. The first example replaces 2 characters starting from position 2 with 'xxx'. The second example replaces 2 characters starting from position 3 with 'CD'.

```SQL
SELECT INSERT('abc',2,2,'xxx'),  
       INSERT('abcdef',3,2,'CD');
```

--------------------------------

### Preparation for Expression Index Examples

Source: https://docs.exasol.com/db/latest/performance/indexes.htm

Sets up two tables and inserts sample data for demonstrating expression index creation.

```sql
create or replace table t1 (id int, name varchar(20000));
create or replace table t2 (id int, name varchar(20000));

insert into t1 values (1, 'Jeff'),(2,'John'),(3,'Jacob');
insert into t2 values (1, 'Jeff'),(2,'John'),(4,'Max');
```

--------------------------------

### Install Perl dependencies for troubleshooting

Source: https://docs.exasol.com/db/latest/connect_exasol/drivers/odbc/odbc_linux.htm

Commands to install required Perl packages on minimal Linux distributions if config_odbc fails to start.

```bash
apt-get install perl
```

```bash
yum install perl-Digest-MD5
```

--------------------------------

### Create Table Example

Source: https://docs.exasol.com/db/latest/sql/desc%5Bribe%5D.htm

This snippet demonstrates how to create a table with specified column types, distribution, and partitioning keys. It serves as a prerequisite for describing the table.

```SQL
CREATE TABLE t (i DECIMAL COMMENT IS 'id column',  
         d DECIMAL(20,5),  
         j DATE,  
         k VARCHAR(5),  
         DISTRIBUTE BY i,  
         PARTITION BY d);
```

--------------------------------

### SQL SIGN Function Example

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/sign.htm

Demonstrates how to use the SIGN function to get the sign of a negative number.

```sql
SELECT SIGN(-123);
```

--------------------------------

### Deploy using presets

Source: https://docs.exasol.com/db/latest/get_started/exasol_personal_administration.htm

Examples of deploying Exasol Personal using built-in or custom local preset paths.

```bash
exasol install <infra-preset> [install-preset]  
  
exasol install aws            # built-in preset by name  
exasol install ./my-preset    # local preset by path (starts with . / ~ or contains /)  
exasol install ./my-infra ./my-install   # both presets from local paths
```

--------------------------------

### Get Week Number of a Date

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/week.htm

Returns the ISO-8601 week number for a specific date. Weeks start on Monday.

```sql
SELECT WEEK(DATE '2012-01-05') WEEK;
```

--------------------------------

### Create configuration file with nano

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/create_configuration.htm

Use the nano text editor to create the configuration file in the directory containing the c4 binary.

```bash
nano ./config
```

--------------------------------

### Get Databases

Source: https://docs.exasol.com/db/latest/administration/rest_api/rest_api.htm

Retrieves a list of databases for a given account. This is an example of how to interact with the Exasol SaaS REST API using curl.

```APIDOC
## GET /api/v1/accounts/{accountId}/databases

### Description
Retrieves a list of databases associated with a specific account.

### Method
GET

### Endpoint
/api/v1/accounts/{accountId}/databases

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The unique identifier of the account.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET "https://cloud.exasol.com/api/v1/accounts/sd1Eks1bSY22B6eNL2T0jw/databases" -H "accept: application/json" -H "Authorization: Bearer <your-personal-access-token>"
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the database.
- **name** (string) - The name of the database.
- **clusters** (object) - Information about the database clusters.
  - **total** (integer) - The total number of clusters.
  - **running** (integer) - The number of running clusters.
- **provider** (string) - The cloud provider where the database is hosted (e.g., AWS).
- **region** (string) - The region where the database is located.
- **usedStorage** (integer) - The amount of storage used by the database.
- **createdAt** (string) - The timestamp when the database was created.
- **createdBy** (string) - The identifier of the user who created the database.
- **status** (string) - The current status of the database (e.g., 'tocreate').

#### Response Example
```json
[
  {
    "id": "5df0HVAcTuWY4xkoBvgzcA",
    "name": "Database01",
    "clusters": {
      "total": 1,
      "running": 0
    },
    "provider": "AWS",
    "region": "eu-central-1",
    "usedStorage": 0,
    "createdAt": "2021-05-21T10:18:54",
    "createdBy": "00umiyjw8OXBtXQ2O416",
    "status": "tocreate"
  }
]
```
```

--------------------------------

### Start and Verify Backup

Source: https://docs.exasol.com/db/latest/administration/on-premise/backup_restore/run_manual_backup.htm

Commands to initiate a database backup and verify its creation.

```bash
confd_client db_backup_start db_name: DATABASE_NAME backup_volume_name: VOLUME_NAME level: LEVEL expire: 'EXPIRE_TIME'
```

```bash
confd_client db_backup_start db_name: MY_DATABASE backup_volume_name: r0001 level: 0 expire: '1w'
```

```bash
confd_client db_backup_list db_name: MY_DATABASE
```

--------------------------------

### Exasol Script Return Examples

Source: https://docs.exasol.com/db/latest/database_concepts/scripting/db_interaction.htm

Demonstrates returning rowcounts, query result tables, and manually constructed tables from scripts.

```sql
-- script which returns rowcount  
--/  
CREATE SCRIPT script_1 AS  
    function my_function(a, b)  
        if a == true then  
            exit()         -- exit whole script  
        else  
            return b, b+1     -- returning result of function  
        end  
    end  
    local x, y = my_function(false, 5) --> y=6  
    exit({rows_affected=y}) -- return rows_affected  
/  
  
-- script which returns result table of query  
--/  
CREATE SCRIPT script_2 RETURNS TABLE AS  
    exit(query([[SELECT * FROM DUAL]]))  
/  
  
-- return explicitly created table  
--/  
CREATE SCRIPT script_3 RETURNS TABLE AS  
    local result_table = {{decimal(1),"abc",true},  
                   {decimal(2),"xyz",false},  
                   {decimal(3),nil,nil}}  
    exit(result_table, "i int, c char(3), b bool")  
/  
EXECUTE SCRIPT script_3;
```

--------------------------------

### Integer Division with DIV Function

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/div.htm

Use the DIV function to get the integer quotient of two numbers. This example divides 15 by 6.

```sql
SELECT DIV(15,6) DIV;
```

--------------------------------

### Execute db_backup_start via Command Line

Source: https://docs.exasol.com/db/latest/confd/jobs/db_backup_start.htm

Initiates a database backup using the confd_client command-line interface.

```bash
confd_client db_backup_start db_name: exa_db backup_volume_name: ArchiveVolume1 level: 0 expire: 1w
```

--------------------------------

### Find First Numeric Sequence and Second Email Address

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/regexp_instr.htm

This snippet demonstrates finding the starting position of the first numeric sequence in a string and the starting position of the second email address in another string. The second example uses optional parameters for position and occurrence.

```sql
SELECT REGEXP_INSTR('Phone: +497003927877678',  
                         '\+?\d+'  
                        ) REGEXP_INSTR1,  
    REGEXP_INSTR('From: my_mail@yahoo.com - To: SERVICE@EXASOL.COM',  
                         '(?i)[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,4}',       
                         1,  
                         2  
                        ) REGEXP_INSTR2;
```

--------------------------------

### Script Line Numbering Error Example

Source: https://docs.exasol.com/db/latest/database_concepts/scripting/db_interaction.htm

Illustrates how script line numbers are calculated starting from the first line after the AS keyword, which can affect error reporting.

```SQL
--/  
CREATE SCRIPT my_script AS  
    -- this is the first line!  
    function do_nothing()  
    return  
    end  
    import(x) -- error: string expected  
/
```

--------------------------------

### Accessing a Virtual Table

Source: https://docs.exasol.com/db/latest/database_concepts/virtual_schema/how_it_works.htm

This is a basic example of how to query a virtual table. The backend process involves starting a language container, negotiating capabilities, and sending pushdown requests.

```sql
SELECT name FROM VIRTUAL_SCHEMA_TEST.users WHERE name like 'A%';
```

--------------------------------

### Get DUMP of a string with special characters in hexadecimal format

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/dump.htm

Returns the byte length, character set, and internal representation of the string 'üäö45' starting from the first character, formatted in hexadecimal notation.

```sql
SELECT DUMP('üäö45',16) DUMP;
```

--------------------------------

### Connect to subsystems

Source: https://docs.exasol.com/db/latest/administration/on-premise/c4/using_c4.htm

Examples of connecting to specific subsystems like host, cos, or db.

```bash
c4 connect -i c3275f84 -n 11 -s host
```

```bash
c4 connect -i c3275f84 -s host
```

```bash
c4 connect -t 1.11/host
```

```bash
c4 connect -t 1/host
```

```bash
c4 connect -i c3275f84 -s cos
```

```bash
c4 connect -t 1/cos
```

```bash
c4 connect -i c3275f84 -s db
```

```bash
c4 connect -i c3275f84
```

```bash
c4 connect -t 1/db
```

```bash
c4 connect -t 1
```

--------------------------------

### Get NVIDIA Container CLI Info

Source: https://docs.exasol.com/db/latest/administration/on-premise/gpu_support/gpu_nvidia_validation.htm

The `nvidia-container-cli info` command verifies that the container tooling is correctly installed and recognizes the available GPUs. It displays NVRM and CUDA versions, and details about each detected GPU.

```bash
$ nvidia-container-cli info
NVRM version:	535.247.01 
CUDA version:	12.2 
Device Index:	0 
Device Minor:	0 
Model:		Tesla T4 
Brand:		Nvidia 
GPU UUID:	GPU-43aae450-f01d-5854-12d2-7ae261f27920 
Bus Location:	00000000:00:1e.0 
Architecture:	7.5
```

--------------------------------

### Connect to host subsystem

Source: https://docs.exasol.com/db/latest/administration/on-premise/c4/c4_install.htm

Examples for connecting to the host OS on a node.

```bash
c4 connect -i c3275f84 -n 11 -s host
```

```bash
c4 connect -i c3275f84 -s host
```

```bash
c4 connect -t 1.11/host
```

```bash
c4 connect -t 1/host
```

--------------------------------

### LEAD Analytic Function Example

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/lead.htm

Demonstrates how to use the LEAD function to get the ID from the next row within each department, ordered by hire date. The offset is 1, and a default value of NULL is used if no subsequent row exists.

```SQL
SELECT 
    id, department, hire_date, 
    LEAD(id, 1) OVER (PARTITION BY department ORDER BY hire_date) LEAD 
FROM employee_table ORDER BY department, hire_date;
```

--------------------------------

### Execute db_snapshot_backup_start via CLI

Source: https://docs.exasol.com/db/latest/confd/jobs/db_snapshot_backup_start.htm

Initiates a database snapshot using the confd_client command line tool.

```bash
confd_client db_snapshot_backup_start db_name: exa_db expire: 1w
```

--------------------------------

### Detecting Cycles in Hierarchical Queries with CONNECT_BY_ISCYCLE

Source: https://docs.exasol.com/db/latest/sql_references/functions/alphabeticallistfunctions/connect_by_iscycle.htm

This SQL snippet demonstrates how to use the CONNECT_BY_ISCYCLE function in an Exasol database. It's used in conjunction with a CONNECT BY clause to identify rows that form a cycle, returning 1 if a cycle is detected and 0 otherwise. The example queries the 'employees' table to find cycles starting from 'Clark'.

```sql
SELECT CONNECT_BY_ISCYCLE,  
       SYS_CONNECT_BY_PATH(last_name, '/') "PATH"  
  FROM employees WHERE last_name = 'Clark'  
  CONNECT BY NOCYCLE PRIOR employee_id = manager_id  
  START WITH last_name = 'Clark';
```

--------------------------------

### Install Exasol Agent Skills

Source: https://docs.exasol.com/db/latest/ai/ai_build_agents/index.htm

This script installs the necessary agent skills for Exasol development. Ensure you have curl installed.

```bash
curl -fsSL https://raw.githubusercontent.com/exasol-labs/exasol-agent-skills/main/install.sh | sh
```

--------------------------------

### Install Kernel Headers and Development Packages

Source: https://docs.exasol.com/db/latest/administration/on-premise/gpu_support/gpu_install_driver_rhel.htm

Install the necessary kernel-devel and kernel-headers packages for your current kernel version. This is required for driver installation.

```bash
sudo dnf -y install kernel-devel-$(uname -r) kernel-headers-$(uname -r)
```

--------------------------------

### Connect to database subsystem

Source: https://docs.exasol.com/db/latest/administration/on-premise/c4/c4_install.htm

Examples for connecting to the database using the built-in SQL client.

```bash
c4 connect -i c3275f84 -s db
```

```bash
c4 connect -i c3275f84
```

```bash
c4 connect -t 1/db
```

```bash
c4 connect -t 1
```

--------------------------------

### Install devtools Package in R

Source: https://docs.exasol.com/db/latest/connect_exasol/drivers/package_r.htm

Install the 'devtools' package in R, which is required for installing the Exasol R package from GitHub. Run this command in your R environment.

```r
install.packages("devtools")
```

--------------------------------

### Configure Import Parameters

Source: https://docs.exasol.com/db/latest/loading_data/load_data_local_remote_location.htm

Examples of applying configuration parameters for local and remote imports.

```sql
-- local file  
IMPORT INTO my_schema.my_table  
	FROM LOCAL PARQUET  
	CONFIG 'MaxConnections=2;MaxBatchFetchSize=1;MaxConcurrentReads=1'  
	FILE '/home/user/test.parquet'  
;  
  
-- remote file (using saved connection)  
IMPORT INTO my_schema.my_table  
	FROM PARQUET  
	AT 'my_conn;MaxConnections=2;MaxBatchFetchSize=1'  
	FILE '/home/user/test.parquet'  
;
```

--------------------------------

### Install Ubuntu Kernel Headers

Source: https://docs.exasol.com/db/latest/administration/on-premise/gpu_support/gpu_install_driver_ubuntu.htm

Update the package list and install the kernel headers for the current running kernel. This is a prerequisite for installing DKMS-based NVIDIA drivers.

```bash
sudo apt update  
sudo apt install linux-headers-$(uname -r)
```

--------------------------------

### Example of Script Import and Usage

Source: https://docs.exasol.com/db/latest/database_concepts/udf_scripts/lua.htm

Demonstrates creating a library script and importing it into another script to call its functions.

```lua
--/  
CREATE OR REPLACE LUA SCALAR SCRIPT LIB.MYLIB() RETURNS INT AS  
function helloWorld()  
	return "Hello Lua World!"  
end  
/  
  
--/  
CREATE OR REPLACE LUA SCALAR SCRIPT TEST.MYHELLOWORLD() 
   RETURNS VARCHAR(2000) AS  
  
exa.import("LIB.MYLIB","MYLIB")  
  
function run(ctx)  
	return MYLIB.helloWorld()  
end  
/  
  
select TEST.MYHELLOWORLD();
```

--------------------------------

### Run the preplay script

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_rootless.htm

Executes the preplay script to apply necessary system configurations for rootless deployment.

```bash
sudo ./c4 _ preplay <EXASOL_USER>
```

```bash
./c4 _ preplay -D
```

--------------------------------

### Install Exasol Governed SQL MCP Server

Source: https://docs.exasol.com/db/latest/ai/ai_ask_db/natural-language-queries.htm

Install the Exasol Governed SQL MCP Server package using the 'uv' package manager. Ensure you have Python 3.12 or higher installed.

```bash
uv tool install exasol-mcp-server-governed-sql@latest
```

--------------------------------

### Load Sample Data via CLI

Source: https://docs.exasol.com/db/latest/get_started/exasol_personal_administration.htm

Import the provided sample dataset using a SQL script file.

```bash
exasol connect < sample.sql
```

--------------------------------

### Install Exasol MCP Server locally

Source: https://docs.exasol.com/db/latest/ai/ai_ask_db/connect-ai-assistants-mcp.htm

Install the Exasol MCP server package locally using the uv tool. This allows you to configure Claude Desktop to use the locally installed server.

```bash
uv tool install exasol-mcp-server@latest
```

--------------------------------

### Reinstall NVIDIA DKMS Kernel Modules

Source: https://docs.exasol.com/db/latest/administration/on-premise/gpu_support/gpu_nvidia_validation.htm

If DKMS status indicates missing or incorrect installations, use `dkms autoinstall` to explicitly install the kernel modules. A system restart is required after installation.

```bash
$ sudo dkms autoinstall
```

--------------------------------

### Connect to Exasol and Prepare Database

Source: https://docs.exasol.com/db/latest/advanced_analytics/package_r/train_locally_predict_in_exasol.htm

Establishes a connection to the Exasol database, creates a schema if it doesn't exist, opens the schema, and creates an empty table for data storage.

```R
exaconn <- dbConnect(
    drv       = "exa",
    exahost = "192.168.56.103:8563",
    uid       = "sys",
    pwd       = "exasol")

odbcQuery(exaconn, "CREATE SCHEMA IF NOT EXISTS r_demo")

odbcQuery(exaconn, "OPEN SCHEMA r_demo")

odbcQuery(exaconn,
    "CREATE OR REPLACE TABLE boston_housing(
        crim    DOUBLE,
        zn      DOUBLE,
        indus   DOUBLE,
        chas    VARCHAR(10),
        nox     DOUBLE,
        rm      DOUBLE,
        age     DOUBLE,
        dis     DOUBLE,
        rad     DOUBLE,
        tax     DOUBLE,
        ptratio DOUBLE,
        b       DOUBLE,
        lstat   DOUBLE,
        medv    DOUBLE,
        split   VARCHAR(10),
        id      INT
    )")
```

--------------------------------

### Install MLflow server dependencies

Source: https://docs.exasol.com/db/latest/ai/ai_connect_models/mlflow-model-serving.htm

Clone the repository and install the required Python dependencies.

```bash
git clone https://github.com/exasol-labs/exasol-labs-mlflow-server.git  
cd exasol-labs-mlflow-server  
pip install -r requirements.txt
```

--------------------------------

### Exasol JDBC driver configuration example

Source: https://docs.exasol.com/db/latest/administration/manage_drivers/add_jdbc_driver.htm

A sample configuration file for connecting to another Exasol system.

```text
DRIVERNAME=EXASOL_JDBC  
PREFIX=jdbc:exa:  
FETCHSIZE=100000  
INSERTSIZE=-1  

```

--------------------------------

### Sample Exasol Configuration File

Source: https://docs.exasol.com/db/latest/administration/on-premise/installation/install_as_app/create_configuration.htm

A template configuration file for deploying Exasol 8 with specific node, disk, and admin UI settings.

```bash
CCC_HOST_ADDRS="10.0.0.11 10.0.0.12 10.0.0.13 10.0.0.14"  
CCC_HOST_EXTERNAL_ADDRS="203.0.113.11 203.0.113.12 203.0.113.13 203.0.113.14"  
CCC_HOST_DATADISK=/dev/mapper/exasol_disk_1,/dev/mapper/exasol_disk_2  
CCC_HOST_IMAGE_USER=exasol  
CCC_HOST_IMAGE_PASSWORD=exasol123  
CCC_HOST_KEY_PAIR_FILE=id_rsa  
CCC_PLAY_RESERVE_NODES=1  
CCC_PLAY_WORKING_COPY=@exasol-2025.1.0  
CCC_PLAY_DB_PASSWORD=exasol456  
CCC_PLAY_ADMIN_PASSWORD=exasol789  
CCC_ADMINUI_START_SERVER=true
```

--------------------------------

### Install Exasol AI Process Mining Demonstrator

Source: https://docs.exasol.com/db/latest/ai/ai_application/ai-process-mining.htm

Installs the AI Process Mining demonstrator package from a GitHub repository using pip. This command fetches and installs the latest version of the tool for use with Exasol.

```bash
pip install git+https://github.com/exasol-labs/exasol-labs-ai-process-mining.git
```

--------------------------------

### Install Text AI Extension

Source: https://docs.exasol.com/db/latest/ai/ai_application/extract-insights-from-text.htm

Install the extension package using pip for standalone environments.

```bash
pip install exasol_text_ai_extension
```

--------------------------------

### PUT /api/v1/databases/$DATABASE_ID/backups/start

Source: https://docs.exasol.com/db/latest/administration/on-premise/admin_interface/administration_api_examples.htm

Starts a manual backup process for the database.

```APIDOC
## PUT /api/v1/databases/$DATABASE_ID/backups/start

### Description
Initiates a manual backup for the specified database.

### Method
PUT

### Endpoint
/api/v1/databases/$DATABASE_ID/backups/start

### Parameters
#### Path Parameters
- **$DATABASE_ID** (string) - Required - The ID of the database.

#### Request Body
- **backupVolumeId** (integer) - Required - The ID of the backup volume.
- **backupVolumeName** (string) - Required - The name of the backup volume.
- **level** (integer) - Required - The backup level (full or incremental).
- **expire** (string) - Required - The expiration time in format #w #d #h #m.
```

--------------------------------

### Parameter Data Type Examples

Source: https://docs.exasol.com/db/latest/administration/on-premise/c4/c4_parameters.htm

Examples of valid formats for different parameter data types.

```text
CCC_PLAY_ADMIN_PASSWORD=df0g98j_98Xc CCC_USER_FULLNAME=”Alice User”
```

```text
CCC_PLAY_DB_PORT=8563
```

```text
CCC_HOST_CLEANUP=false
```

--------------------------------

### Install Exasol Transformers Extension

Source: https://docs.exasol.com/db/latest/ai/ai_connect_models/open-source-models.htm

Install the Python package for the Exasol Transformers Extension using pip.

```bash
pip install exasol-transformers-extension
```

--------------------------------

### Create a Bucket via Command Line

Source: https://docs.exasol.com/db/latest/administration/on-premise/bucketfs/create_new_bucketfs_bucket.htm

Use the confd_client tool to execute the bucket_add job with the required bucket parameters.

```bash
confd_client bucket_add bucket_name: my_bucket bucketfs_name: my_bucketfs public: False read_password: READPW write_password: WRITEPW
```
Tokens:
Raw