vsql info

vsql_commands.txt

See the Vertica Programmer's Guide for information on available commands.

General
  \c[onnect] [DBNAME|- [USER]]
                 connect to new database (currently "localdev")
  \cd [DIR]      change the current working directory
  \q             quit vsql
  \set [NAME [VALUE]]
                 set internal variable, or list all if no parameters
  \timing        toggle timing of commands (currently off)
  \unset NAME    unset (delete) internal variable
  \! [COMMAND]   execute command in shell or start interactive shell
  \password [USER]
                 change user's password

Query Buffer
  \e [FILE]      edit the query buffer (or file) with external editor
  \g             send query buffer to server
  \g FILE        send query buffer to server and results to file
  \g | COMMAND   send query buffer to server and pipe results to command
  \p             show the contents of the query buffer
  \r             reset (clear) the query buffer
  \s [FILE]      display history or save it to file
  \w FILE        write query buffer to file

Input/Output
  \echo [STRING] write string to standard output
  \i FILE        execute commands from file
  \o FILE        send all query results to file
  \o | COMMAND   pipe all query results to command
  \o             close query-results file or pipe
  \qecho [STRING]
                 write string to query output stream (see \o)

Informational
  \d [PATTERN]   describe tables (list tables if no argument is supplied)
                 PATTERN may include system schema name, e.g. v_catalog.*
  \df [PATTERN]  list functions
  \dj [PATTERN]  list projections
  \dn [PATTERN]  list schemas
  \dp [PATTERN]  list table access privileges
  \ds [PATTERN]  list sequences
  \dS [PATTERN]  list system tables. PATTERN may include system schema name
                 such as v_catalog, v_monitor, or v_internal.
                 Example: v_catalog.a*
  \dt [PATTERN]  list tables
  \dtv [PATTERN] list tables and views
  \dT [PATTERN]  list data types
  \du [PATTERN]  list users
  \dv [PATTERN]  list views
  \l             list all databases
  \z [PATTERN]   list table access privileges (same as \dp)

Formatting
  \a             toggle between unaligned and aligned output mode
  \b             toggle beep on command completion
  \C [STRING]    set table title, or unset if none
  \f [STRING]    show or set field separator for unaligned query output
  \H             toggle HTML output mode (currently off)
  \pset NAME [VALUE]
                 set table output option
                 (NAME := {format|border|expanded|fieldsep|footer|null|
                 recordsep|tuples_only|title|tableattr|pager})
  \t             show only rows (currently off)
  \T [STRING]    set HTML <table> tag attributes, or unset if none
  \x             toggle expanded output (currently off)

vsql_system_tables.txt

  Schema   |                 Name                  |  Kind  |                                          Description                                           | Comment
-----------+---------------------------------------+--------+------------------------------------------------------------------------------------------------+---------
 v_catalog | access_policy                         | system | Access Policy information                                                                      |
 v_catalog | all_tables                            | system | A complete listing of all tables and views                                                     |
 v_catalog | client_auth                           | system | Client Authentication Detailed information                                                     |
 v_catalog | client_auth_params                    | system | Client Authentication Paramters                                                                |
 v_catalog | cluster_layout                        | system | Current cluster layout with relative ordering of nodes                                         |
 v_catalog | columns                               | system | Table column information                                                                       |
 v_catalog | comments                              | system | User comments on catalog objects                                                               |
 v_catalog | constraint_columns                    | system | Table column constraint information                                                            |
 v_catalog | databases                             | system | Database information                                                                           |
 v_catalog | dual                                  | system | Oracle(TM) compatibility DUAL table                                                            |
 v_catalog | elastic_cluster                       | system | Information about cluster elasticity                                                           |
 v_catalog | epochs                                | system | Mapping from time to epoch (potentially sparse)                                                |
 v_catalog | fault_groups                          | system | Fault Group information                                                                        |
 v_catalog | foreign_keys                          | system | Foreign key information                                                                        |
 v_catalog | grants                                | system | Grant information                                                                              |
 v_catalog | hcatalog_columns                      | system | HCatalog table column information                                                              |
 v_catalog | hcatalog_schemata                     | system | HCatalog schema information                                                                    |
 v_catalog | hcatalog_table_list                   | system | HCatalog table list                                                                            |
 v_catalog | hcatalog_tables                       | system | HCatalog table information                                                                     |
 v_catalog | large_cluster_configuration_status    | system | Status of nodes for large cluster management                                                   |
 v_catalog | license_audits                        | system | Database license compliance computation details                                                |
 v_catalog | licenses                              | system | Licenses installed in the database                                                             |
 v_catalog | materialize_flextable_columns_results | system | Most recent results per flex table for each key name considered for materialization            |
 v_catalog | nodes                                 | system | Node information                                                                               |
 v_catalog | odbc_columns                          | system | An ODBC compliant listing of column metadata                                                   |
 v_catalog | password_auditor                      | system | password security information                                                                  |
 v_catalog | passwords                             | system | User password history and password reuse policy                                                |
 v_catalog | primary_keys                          | system | Primary key information                                                                        |
 v_catalog | profile_parameters                    | system | Profile Parameters information                                                                 |
 v_catalog | profiles                              | system | Profile information                                                                            |
 v_catalog | projection_checkpoint_epochs          | system | Projection checkpoint epochs                                                                   |
 v_catalog | projection_columns                    | system | Projection columns information                                                                 |
 v_catalog | projection_delete_concerns            | system | Projections that may have delete performance concerns                                          |
 v_catalog | projections                           | system | Projection information                                                                         |
 v_catalog | resource_pool_defaults                | system | Information about default values for resource pools properties, both internal and dba-created  |
 v_catalog | resource_pools                        | system | Information about defined resource pools, both internal and dba-created                        |
 v_catalog | roles                                 | system | Role information                                                                               |
 v_catalog | schemata                              | system | Schema information                                                                             |
 v_catalog | sequences                             | system | Sequence information                                                                           |
 v_catalog | storage_locations                     | system | Storage Location Information                                                                   |
 v_catalog | system_columns                        | system | System column information                                                                      |
 v_catalog | system_tables                         | system | Displays a list of all system tables except internal ones                                      |
 v_catalog | table_constraints                     | system | Constraint information                                                                         |
 v_catalog | tables                                | system | Table information                                                                              |
 v_catalog | types                                 | system | Information about supported data types                                                         |
 v_catalog | user_audits                           | system | User-requested database object size computation details                                        |
 v_catalog | user_client_auth                      | system | Client Authentication for Users                                                                |
 v_catalog | user_functions                        | system | User Defined Function information                                                              |
 v_catalog | user_procedures                       | system | User procedure information                                                                     |
 v_catalog | user_transforms                       | system | User Defined Transform Function information                                                    |
 v_catalog | users                                 | system | User information                                                                               |
 v_catalog | view_columns                          | system | View column information                                                                        |
 v_catalog | views                                 | system | View information                                                                               |
 v_monitor | active_events                         | system | Displays all of the active events in the cluster                                               |
 v_monitor | column_storage                        | system | Information on the amount of disk storage used by each column of each projection on each node. |
 v_monitor | configuration_changes                 | system | Configuration parameter (vertica.conf) change history                                          |
 v_monitor | configuration_parameters              | system | Configuration Parameters information                                                           |
 v_monitor | cpu_usage                             | system | CPU usage history                                                                              |
 v_monitor | critical_hosts                        | system | Hosts whose failure will result in cluster shutdown                                            |
 v_monitor | critical_nodes                        | system | Nodes whose failure will result in cluster shutdown                                            |
 v_monitor | current_session                       | system | Information on current Session                                                                 |
 v_monitor | data_collector                        | system | Statistics on all Usage Data Collector logs                                                    |
 v_monitor | database_backups                      | system | Database backup history                                                                        |
 v_monitor | database_connections                  | system | List of connections to other Vertica databases                                                 |
 v_monitor | database_snapshots                    | system | Information on stored database snapshots                                                       |
 v_monitor | delete_vectors                        | system | Information on delete vectors                                                                  |
 v_monitor | deploy_status                         | system | Monitor the current (or last) DBD deployment progress                                          |
 v_monitor | deployment_projection_statements      | system | Deployment projection statements from current DBD designs                                      |
 v_monitor | deployment_projections                | system | Projections to be deployed from current DBD designs                                            |
 v_monitor | design_queries                        | system | Current DBD design queries                                                                     |
 v_monitor | design_status                         | system | Monitor the current (or last) DBD design progress                                              |
 v_monitor | design_tables                         | system | Current DBD design tables                                                                      |
 v_monitor | designs                               | system | Current DBD designs                                                                            |
 v_monitor | dfs_storage                           | system | Metadata on files stored in the Vertica Distributed File System                                |
 v_monitor | disk_resource_rejections              | system | Disk Resource Rejection Summarizations                                                         |
 v_monitor | disk_storage                          | system | Disk usage information                                                                         |
 v_monitor | error_messages                        | system | Error and warning messages encountered while processing queries                                |
 v_monitor | event_configurations                  | system | Current Event configuration                                                                    |
 v_monitor | execution_engine_profiles             | system | Per EE operator profiling information                                                          |
 v_monitor | host_resources                        | system | Per host profiling information                                                                 |
 v_monitor | io_usage                              | system | Disk I/O bandwidth usage history                                                               |
 v_monitor | load_streams                          | system | Load metrics for each load stream on each node.                                                |
 v_monitor | lock_usage                            | system | Lock usage information wait time/count and hold time/count                                     |
 v_monitor | locks                                 | system | Lock grants and requests for all nodes                                                         |
 v_monitor | login_failures                        | system | User login failures                                                                            |
 v_monitor | memory_usage                          | system | Memory usage history                                                                           |
 v_monitor | merge_streams                         | system | External merge sort information for all nodes.                                                 |
 v_monitor | monitoring_events                     | system | All system event history                                                                       |
 v_monitor | network_interfaces                    | system | Information about network interfaces on all Vertica nodes                                      |
 v_monitor | network_usage                         | system | Network bandwidth usage history                                                                |
 v_monitor | node_resources                        | system | Per node profiling information                                                                 |
 v_monitor | node_states                           | system | Node recovery state change history                                                             |
 v_monitor | output_deployment_status              | system | Projection deployment status of current DBD designs                                            |
 v_monitor | output_event_history                  | system | Monitor progress of current DBD designs                                                        |
 v_monitor | output_query_plan_costs               | system | Query plan costs for current DBD designs                                                       |
 v_monitor | partition_columns                     | system | Column disk space per partition                                                                |
 v_monitor | partition_reorganize_errors           | system | Background Partition Reorganize Errors                                                         |
 v_monitor | partition_status                      | system | Partition Status                                                                               |
 v_monitor | partitions                            | system | Partition Metadata                                                                             |
 v_monitor | process_signals                       | system | History of signals handled                                                                     |
 v_monitor | projection_recoveries                 | system | Recovery status per projection                                                                 |
 v_monitor | projection_refreshes                  | system | Historical and current projection refreshes                                                    |
 v_monitor | projection_storage                    | system | Storage information on each Projection                                                         |
 v_monitor | projection_usage                      | system | Projection usage history                                                                       |
 v_monitor | query_events                          | system | Query optimization, planning and execution events                                              |
 v_monitor | query_metrics                         | system | Summarized query information                                                                   |
 v_monitor | query_plan_profiles                   | system | Numbers for plan queries                                                                       |
 v_monitor | query_profiles                        | system | Query profiles                                                                                 |
 v_monitor | query_requests                        | system | User-issued query requests                                                                     |
 v_monitor | rebalance_projection_status           | system | Rebalance progress for relevant projections.                                                   |
 v_monitor | rebalance_table_status                | system | Rebalance progress for relevant tables.                                                        |
 v_monitor | recovery_status                       | system | Overall recovery status                                                                        |
 v_monitor | resource_acquisitions                 | system | Resource acquisition history for user queries                                                  |
 v_monitor | resource_pool_move                    | system | Resource pool moves history                                                                    |
 v_monitor | resource_pool_status                  | system | Resource pool usage Information                                                                |
 v_monitor | resource_queues                       | system | Queries waiting to acquire resources                                                           |
 v_monitor | resource_rejection_details            | system | Resource rejection history                                                                     |
 v_monitor | resource_rejections                   | system | Resource Rejection Summarizations                                                              |
 v_monitor | resource_usage                        | system | Resource usage Information                                                                     |
 v_monitor | session_parameters                    | system | Session Parameters information                                                                 |
 v_monitor | projection_refreshes                  | system | Historical and current projection refreshes                                                    |
 v_monitor | projection_storage                    | system | Storage information on each Projection                                                         |
 v_monitor | projection_usage                      | system | Projection usage history                                                                       |
 v_monitor | query_events                          | system | Query optimization, planning and execution events                                              |
 v_monitor | query_metrics                         | system | Summarized query information                                                                   |
 v_monitor | query_plan_profiles                   | system | Numbers for plan queries                                                                       |
 v_monitor | query_profiles                        | system | Query profiles                                                                                 |
 v_monitor | query_requests                        | system | User-issued query requests                                                                     |
 v_monitor | rebalance_projection_status           | system | Rebalance progress for relevant projections.                                                   |
 v_monitor | rebalance_table_status                | system | Rebalance progress for relevant tables.                                                        |
 v_monitor | recovery_status                       | system | Overall recovery status                                                                        |
 v_monitor | resource_acquisitions                 | system | Resource acquisition history for user queries                                                  |
 v_monitor | resource_pool_move                    | system | Resource pool moves history                                                                    |
 v_monitor | resource_pool_status                  | system | Resource pool usage Information                                                                |
 v_monitor | resource_queues                       | system | Queries waiting to acquire resources                                                           |
 v_monitor | resource_rejection_details            | system | Resource rejection history                                                                     |
 v_monitor | resource_rejections                   | system | Resource Rejection Summarizations                                                              |
 v_monitor | resource_usage                        | system | Resource usage Information                                                                     |
 v_monitor | session_parameters                    | system | Session Parameters information                                                                 |
 v_monitor | session_profiles                      | system | Per session profiling information                                                              |
 v_monitor | sessions                              | system | Information on each Session                                                                    |
 v_monitor | storage_containers                    | system | Information on each storage container                                                          |
 v_monitor | storage_policies                      | system | Storage tier policies                                                                          |
 v_monitor | storage_tiers                         | system | Tiered Storage Information                                                                     |
 v_monitor | storage_usage                         | system | File system storage usage                                                                      |
 v_monitor | strata                                | system | Information of strata used in Tuple Mover, one row per stratum                                 |
 v_monitor | strata_structures                     | system | Information of strata structures used in Tuple Mover, one row per strata structure             |
 v_monitor | system                                | system | System level information                                                                       |
 v_monitor | system_resource_usage                 | system | System resource (memory, cpu, network, disk I/O) usage history                                 |
 v_monitor | system_services                       | system | Background system services                                                                     |
 v_monitor | system_sessions                       | system | System internal session history per system task                                                |
 v_monitor | transactions                          | system | Transaction history                                                                            |
 v_monitor | tuning_recommendations                | system | Aggregated tuning recommendations from workload analyzer                                       |
 v_monitor | tuple_mover_operations                | system | Current and historical tuple mover activities                                                  |
 v_monitor | udx_fenced_processes                  | system | Information about processes Vertica uses to run UDx in fenced mode                             |
 v_monitor | user_libraries                        | system | List of user defined shared libraries                                                          |
 v_monitor | user_library_manifest                 | system | List of exported (by library writers) objects from user defined shared libraries               |
 v_monitor | user_sessions                         | system | User session history                                                                           |
 v_monitor | wos_container_storage                 | system | Storage information on WOS allocator                                                           |
(140 rows)