User Guide - Command Line

Pre requisite

• JRE 1.8 or above

• OS: Windows + Linux+Mac OS

Command

• $ java -jar paw-indexadvisor.jar -c config/config.properties

Configuration

1. config.properties

# The configuration file for index advisor

# Configure the query workload folder:
sqllab.queryfolder               = ./tpch/cases
sqllab.mapperfolder              = ./tpch/mappers

sqllab.querymode                 = offline
sqllab.ddlmode                   = offline
sqllab.statsmode                 = offline

# specify the server info for retrieving DDL/query/stats
sqllab.server.type = mysql
sqllab.server.host               = localhost
sqllab.server.username             = root
sqllab.server.password             = root

# the database list (comma separated)
sqllab.databaselist             = tpch

sqllab.ddlfolder                = ./tpch/ddl/
sqllab.statsfolder              = ./tpch/stats
sqllab.resultfolder          = ./tpch/out/index.sql

2. DDL input

-- sqllab.ddlmode

When offline mode is set，sqllab.ddlfolder should be specified

sqllab.querymode                 = offline
sqllab.ddlfolder                = ./tpch/ddl/

When online mode is set，sqllab.server parameters should be specified, MySQL and PostgreSQL and derivatives, such as Opengauss are supported。

sqllab.ddlmode                   = online

sqllab.server.type                 = mysql
sqllab.server.host                 = localhost
sqllab.server.username             = root
sqllab.server.password             = root
sqllab.databaselist                = tpch

3. Queries

-- querymode

When offline mode is set，sqllab.queryfolder should be specified

sqllab.querymode                 = offline
sqllab.queryfolder               = ./tpch/cases

When mapper mode is set，，sqllab.mapperfolder should be specified

sqllab.querymode                 = mapper
sqllab.mapperfolder              = ./tpch/mappers

4. Output

-- sqllab.resultfolder

sqllab.resultfolder          = ./tpch/out/index.sql