Commands Supported by the Ocient JDBC CLI Program

commands are not case sensitive for ddl statements, see docid\ jf l ie2lupbjgrjw4lqx all commands, except quit, must end with a semicolon at the command line you can cancel any query that does not update data by pressing ctrl+c cancel cancels the current query that is still running on the system syntax cancel uuid; 103,103,365 true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type connect connects to a sql node for details on the connection steps, see docid 1 p8y vgpzkd8k 0hxqd7 syntax connect to \<url> \[ user username using password ] the \<url> parameter must follow this format jdbc\ ocient //node address1\ port1\[,node address2\ port2\[, ]]/database name\[;property=value\[; ]] if you do not specify the username and password , then the database uses the default credentials specified at startup jdbc url parameters 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type additional jdbc url parameters the jdbc url can include these optional parameters in the key value format property=value separate each parameter pair by semicolons url parameters are case insensitive to authenticate using single sign on, set the handshake parameter to sso and leave the user and password parameters empty for example jdbc\ ocient //dnsname\ port\[,ip2\ port2, ]/databasename;handshake=sso;user=;password=; 330,331 true left unhandled content type left unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left unhandled content type left unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left 1 1 unhandled content type left 1 1 unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type describe table lists the columns of the specified table and its associated data types syntax describe table \[schema ]table \[verbose] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type describe view returns the query text used to create the specified view syntax describe view \[schema ]view \[verbose] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type extract extracts a result set in delimited files to a specified location for details about using this command, see docid 1 ls6prwuefq it66b4ee syntax extract to location { local | s3 } \[ options ( \[ param=value \[ , ] ] ) ] as query get jdbc version returns the jdbc version of the driver syntax get jdbc version get schema retrieves the default name schema for tables syntax get schema kill issues a hard kill command to the virtual machine to terminate a query running on the system use only if cancel fails syntax kill uuid 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type list all queries list all the currently executing queries on the database this is the equivalent of executing select from sys queries syntax list all queries list indexes lists the indexes on the specified table and its columns syntax list indexes \[schema ]table \[verbose] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type list system tables lists all system catalog tables in the database syntax list system tables \[verbose] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type list tables lists all tables (in all schemata) in the database syntax list tables \[verbose] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type list views lists all views (in all schemata) in the database syntax list views \[verbose] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type output gis kml outputs the next query in kml format to the specified filename this flag affects only the next query this syntax prints out all gis types to the kml file, and non gis types are added to the description of elements in the same row you can upload this kml file to certain visualization tools syntax output gis kml \<filename> 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type output next query output the next query in csv format to the specified filename this flag only affects the next query all subsequent queries print out their results add append to add output to the specified file instead of overwriting it syntax output next query filename \[append] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type performance enables different levels of query result output for measuring benchmarks by using different performance options syntax performance \[ network | database | off ] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type performance on mode has been removed as of jdbc version 3 0 quit closes the command line interface syntax quit report log on enables {{log4j2}} based metrics collection and redirects reporting events to the configured appenders the report log on command requires jdbc driver version 2 88 or later the log4j configuration determines the destination for report logs the ocient logger name is com ocient util reportlogger for details about configuring log4j, see https //logging apache org/log4j/2 x/manual/configuration html the default log4j configuration routes report logs to the rollingfileappender the default configuration includes these settings properties filename="logs/${sys\ ocient jdbc sessionid unknown}/report log" filepattern="logs/${sys\ ocient jdbc sessionid unknown}/%d{yyyy mm dd} %i report log gz rollover policies timebasedtriggeringpolicy sizebasedtriggeringpolicy (100mb) you can retrieve the default configuration from the ocient jdbc4 jar file by using an archive utility like unzip for example unzip p \<path to ocient jdbc4> log4j2 xml syntax report log on \[ interval ] 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type report log off disables file based metrics collection the report log off command requires jdbc driver version 2 88 or later syntax report log off select retrieves the appropriate result set of a sql select statement syntax sql select statement set maxrows sets the maximum number of rows allowed in a result set applies only to the statement object that executed the command syntax set maxrows num of rows 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set adjustfactor adjusts the query priority by a specified percentage amount at every interval set by the docid\ zyojxip3zkuvr9skpiyxo command the set adjustfactor command requires jdbc driver version 2 52 or later syntax set adjustfactor priorityadjustfactor 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set adjusttime modifies how frequently the query priority is adjusted during the course of execution the set adjusttime command requires jdbc driver version 2 52 or later syntax set adjusttime priorityadjtime 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set maxtempdisk sets the maximum percentage of temporary disk used by queries applies only to the statement object that executed the command syntax set maxtempdisk percentage 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set maxtime sets the maximum query time applies only to the statement object that executed the command syntax set maxtime seconds 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set parallelism sets a limit on the number of cores on each cpu that can be allocated to running the query applies only to the statement object that executed the command the parallelism value limits a query to running on the specified number of cores on each cpu syntax set parallelism parallelism 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set priority sets the scheduling priority to use for queries applies only to the statement object that executed the command syntax set priority priority 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set schema changes the default schema for tables applies only to the statement object that executed the command syntax set schema schema 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type set serviceclass limits a query to using the specified service class applies only to the statement object that executed the command syntax set serviceclass service class name 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type source reads and executes commands found in the specified file syntax source filename 330,331 true unhandled content type unhandled content type unhandled content type unhandled content type timing enables or disables reporting the execution time of each query syntax timing { on | off } related links docid apnndn tjqmjdd5oqdvd https //docs ocient com/system catalog