Alphabetical List of Vertica Meta-Functions

The following list shows all of the Vertica meta-functions in alphabetical order.

Jump to letter: A - B - C - D - E - F - G - H - I - K - L - M - N - P - R - S - V

ADVANCE_EPOCH
Manually closes the current epoch and begins a new epoch.
ALTER_LOCATION_LABEL
Alters the location label.
ALTER_LOCATION_USE
Alters the type of files that can be stored at the specified storage location.
ANALYZE_CONSTRAINTS
Analyzes and reports on constraint violations within the specified scope.
ANALYZE_CORRELATIONS
Analyzes the specified tables for pairs of columns that are strongly correlated.
ANALYZE_EXTERNAL_ROW_COUNT
Calculates the exact number of rows in an external table.
ANALYZE_STATISTICS
Collects and aggregates data samples and storage information from all nodes that store projections associated with the specified table.
ANALYZE_WORKLOAD
Runs the Workload Analyzer (WLA), a utility that analyzes system information held in system tables .
AUDIT
Estimates the raw data size of a database, schema, or table as it is counted in an audit of the database size.
AUDIT_FLEX
Estimates the ROS size of one or more flexible tables contained in a database, schema, or projection.
AUDIT_LICENSE_SIZE
Triggers an immediate audit of the database size to determine if it is in compliance with the raw data storage allowance included in your licenses.
AUDIT_LICENSE_TERM
Triggers an immediate audit to determine if the license has expired.
AWS_GET_CONFIG
Returns the current Amazon Web Services (AWS) credentials set by AWS_SET_CONFIG or ALTER SESSION .
AWS_SET_CONFIG
Gets the values from a table with your Amazon Web Services (AWS) credentials and passes them to session parameters.
BUILD_FLEXTABLE_VIEW
Creates, or re-creates, a view for a default or user-defined _keys table, ignoring any empty keys.
CANCEL_REBALANCE_CLUSTER
Stops any rebalance task that is currently in progress or is waiting to execute.
CANCEL_REFRESH
Cancels refresh-related internal operations initiated by START_REFRESH and REFRESH .
CHANGE_CURRENT_STATEMENT_RUNTIME_PRIORITY
Changes the run-time priority of an active query.
CHANGE_RUNTIME_PRIORITY
Changes the run-time priority of a query that is actively running.
CLEAR_CACHES
Clears the internal cache files.
CLEAR_DATA_COLLECTOR
Clears all memory and disk records on the Data Collector tables and functions and resets collection statistics in the system table DATA_COLLECTOR .
CLEAR_HDFS_CACHES
Clears the configuration information copied from HDFS and any cached connections.
CLEAR_OBJECT_STORAGE_POLICY
Removes an existing storage policy.
CLEAR_PROFILING
Clears from memory data for the specified profiling type.
CLEAR_PROJECTION_REFRESHES
Triggers to clear information about refresh operations for projections immediately.
CLEAR_RESOURCE_REJECTIONS
Clears the content of the RESOURCE_REJECTIONS and DISK_RESOURCE_REJECTIONS system tables.
CLOSE_ALL_RESULTSETS
Closes all result set sessions within Multiple Active Result Sets (MARS) and frees the MARS storage for other result sets.
CLOSE_ALL_SESSIONS
Closes all external sessions except the one that issues this function.
CLOSE_RESULTSET
Closes a specific result set within Multiple Active Result Sets (MARS) and frees the MARS storage for other result sets.
CLOSE_SESSION
Interrupts the specified external session, rolls back the current transaction if any, and closes the socket.
CLOSE_USER_SESSIONS
Stops the session for a user, rolls back any transaction currently running, and closes the connection.
COMPACT_STORAGE
Bundles existing data ( .fdb ) and index ( .pidx ) files into the .gt file format.
COMPUTE_FLEXTABLE_KEYS
Computes the virtual columns (keys and values) from the flex table VMap data.
COMPUTE_FLEXTABLE_KEYS_AND_BUILD_VIEW
Combines the functionality of BUILD_FLEXTABLE_VIEW and COMPUTE_FLEXTABLE_KEYS to compute virtual columns (keys) from the VMap data of a flex table and construct a view.
COPY_PARTITIONS_TO_TABLE
Copies partitions from one table to another.
COPY_TABLE
Copies one table to another.
CURRENT_SCHEMA
Returns the name of the current schema.
DATA_COLLECTOR_HELP
Returns online usage instructions about the Data Collector, the V_MONITOR.DATA_COLLECTOR system table, and the Data Collector control functions.
DELETE_COMMUNITY_KEY
Removes the security key from the database DFS.
DELETE_TOKENIZER_CONFIG_FILE
Deletes a tokenizer configuration file.
DESCRIBE_COMMUNITY_KEY
Retrieves the value of the security key so you can use it in a query.
DESIGNER_ADD_DESIGN_QUERIES
Reads and evaluates queries from an input file, and adds the queries that it accepts to the specified design.
DESIGNER_ADD_DESIGN_QUERIES_FROM_RESULTS
Executes the specified query and evaluates results in the following columns:.
DESIGNER_ADD_DESIGN_QUERY
Reads and parses the specified query, and if accepted, adds it to the design.
DESIGNER_ADD_DESIGN_TABLES
Adds the specified tables to a design.
DESIGNER_CANCEL_POPULATE_DESIGN
Cancels population or deployment operation for the specified design if it is currently running.
DESIGNER_CREATE_DESIGN
Creates a design with the specified name.
DESIGNER_DESIGN_PROJECTION_ENCODINGS
Analyzes encoding in the specified projections, creates a script to implement encoding recommendations, and optionally deploys the recommendations.
DESIGNER_DROP_ALL_DESIGNS
Removes all -related schemas associated with the current user.
DESIGNER_DROP_DESIGN
Removes the schema associated with the specified design and all its contents.
DESIGNER_OUTPUT_ALL_DESIGN_PROJECTIONS
Displays the DDL statements that define the design projections to standard output.
DESIGNER_OUTPUT_DEPLOYMENT_SCRIPT
Displays the deployment script for the specified design to standard output.
DESIGNER_RESET_DESIGN
Discards all run-specific information of the previous build or deployment of the specified design but keeps its configuration.
DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY
Populates the design and creates the design and deployment scripts.
DESIGNER_SET_ANALYZE_CORRELATIONS_MODE
Specifies how handles column correlations in a design.
DESIGNER_SET_DESIGN_KSAFETY
Sets K-safety for a comprehensive design and stores the K-safety value in the DESIGNS table.
DESIGNER_SET_DESIGN_TYPE
Specifies whether should create a comprehensive or incremental design.
DESIGNER_SET_OPTIMIZATION_OBJECTIVE
Valid only for comprehensive database designs, specifies the optimization objective uses.
DESIGNER_SET_PROPOSE_UNSEGMENTED_PROJECTIONS
Specifies whether a design can include unsegmented projections .
DESIGNER_WAIT_FOR_DESIGN
Waits for completion of operations that are populating and deploying the design.
DISABLE_DUPLICATE_KEY_ERROR
Disables error messaging when finds duplicate primary or unique key values at run time (for use with key constraints that are not automatically enabled).
DISABLE_ELASTIC_CLUSTER
Disables elastic cluster scaling, which prevents from bundling data into chunks that are easily transportable to other nodes when performing cluster resizing.
DISABLE_LOCAL_SEGMENTS
Disables local data segmentation, which breaks projections segments on nodes into containers that can be easily moved to other nodes.
DISABLE_PROFILING
Disables profiling for the specified profiling type.
DISPLAY_LICENSE
Returns the terms of your license.
DO_TM_TASK
Runs a Tuple Mover operation on the specified table or projection and commits any current transaction.
DROP_EXTERNAL_ROW_COUNT
Removes external table row count statistics compiled by ANALYZE_EXTERNAL_ROW_COUNT .
DROP_LICENSE
Drops a license key from the global catalog.
DROP_LOCATION
Removes the specified storage location.
DROP_PARTITION
Drops the specified partition.
DROP_STATISTICS
Removes statistical data on database projections previously generated by ANALYZE_STATISTICS .
DUMP_CATALOG
Returns an internal representation of the catalog.
DUMP_LOCKTABLE
Returns information about deadlocked clients and the resources they are waiting for.
DUMP_PARTITION_KEYS
Dumps the partition keys of all projections in the system.
DUMP_PROJECTION_PARTITION_KEYS
Dumps the partition keys of the specified projection.
DUMP_TABLE_PARTITION_KEYS
Dumps the partition keys of all projections for the specified table.
EMPTYMAP
Constructs a new VMap with one row but without keys or data.
ENABLE_ELASTIC_CLUSTER
Enables elastic cluster scaling, which makes enlarging or reducing the size of your database cluster more efficient by segmenting a node's data into chunks that can be easily moved to other hosts.
ENABLE_LOCAL_SEGMENTS
Enables local storage segmentation, which breaks projections segments on nodes into containers that can be easily moved to other nodes.
ENABLE_PROFILING
Enables profiling for the specified profiling type.
ENFORCE_OBJECT_STORAGE_POLICY
Applies object storage policies immediately, instead of waiting for the Tuple Mover to perform the next moveout.
EVALUATE_DELETE_PERFORMANCE
Evaluates projections for potential DELETE performance issues.
EXPORT_CATALOG
Generates a SQL script for recreating a physical schema design on another cluster.
EXPORT_DIRECTED_QUERIES
Generates SQL for creating directed queries from a set of input queries, and writes the SQL to the specified file or to standard output.
EXPORT_OBJECTS
Generates a SQL script you can use to recreate non-virtual catalog objects on another cluster.
EXPORT_STATISTICS
Generates database statistics in XML format from data previously collected by ANALYZE_STATISTICS .
EXPORT_TABLES
Generates a SQL script that can be used to recreate a logical schema—schemas, tables, constraints, and views—on another cluster.
FLUSH_DATA_COLLECTOR
Waits until memory logs are moved to disk and then flushes the Data Collector, synchronizing the log with the disk storage.
GET_AHM_EPOCH
Returns the number of the epoch in which the Ancient History Mark is located.
GET_AHM_TIME
Returns a TIMESTAMP value representing the Ancient History Mark .
GET_AUDIT_TIME
Reports the time when the automatic audit of database size occurs.
GET_CLIENT_LABEL
Returns the client connection label for the current session.
GET_COMPLIANCE_STATUS
Displays whether your database is in compliance with your license agreement.
GET_CURRENT_EPOCH
The epoch into which data (COPY, INSERT, UPDATE, and DELETE operations) is currently being written.
GET_DATA_COLLECTOR_POLICY
Retrieves a brief statement about the retention policy for the specified component.
GET_LAST_GOOD_EPOCH
Returns the last good epoch number.
GET_NUM_ACCEPTED_ROWS
Returns the number of rows loaded into the database for the last completed load for the current session.
GET_NUM_REJECTED_ROWS
Returns the number of rows that were rejected during the last completed load for the current session.
GET_PROJECTIONS
Returns information about projections that are anchored to the specified table, as follows:.
GET_PROJECTION_STATUS
Returns information relevant to the status of a projection :.
GET_TOKENIZER_PARAMETER
Returns the configuration parameter for a given tokenizer.
HAS_ROLE
Indicates, with a Boolean value, whether a role has been assigned to a user.
IDOL_CHECK_ACL
Checks the access control list to verify that the user has permissions to access the data in the IDOL flex table and any views created from the table.
IMPORT_DIRECTED_QUERIES
Imports to the database catalog directed queries from a SQL file that was generated by EXPORT_DIRECTED_QUERIES .
IMPORT_STATISTICS
Imports statistics from the XML file that was generated by EXPORT_STATISTICS .
INSTALL_COMMUNITY_KEY
Stores the Connector Framework Service security key in the Distributed File System (DFS).
INSTALL_LICENSE
Installs the license key in the global catalog.
INTERRUPT_STATEMENT
Interrupts the specified statement in a user session, rolls back the current transaction, and writes a success or failure message to the log file.
KERBEROS_CONFIG_CHECK
Tests the Kerberos configuration of a cluster.
KERBEROS_HDFS_CONFIG_CHECK
Tests the Kerberos configuration of a cluster that uses HDFS.
LAST_INSERT_ID
Returns the last value of a column whose value is automatically incremented through AUTO_INCREMENT or IDENTITY column constraints .
MAKE_AHM_NOW
Sets the Ancient History Mark (AHM) to the greatest allowable value.
MAPAGGREGATE
Returns a LONG VARBINARY VMap with keys and value pairs supplied from two VARCHAR input columns of an existing columnar table.
MAPCONTAINSKEY
Determines whether a VMap contains a virtual column (key).
MAPCONTAINSVALUE
Determines whether a VMap contains a specific value.
MAPDELIMITEDEXTRACTOR
Extracts data with a delimiter character, and other optional arguments, returning a single VMap value.
MAPITEMS
Returns information about items in a VMap.
MAPJSONEXTRACTOR
Extracts content of repeated JSON data objects, including nested maps, or data with an outer list of JSON elements.
MAPKEYS
Returns the virtual columns (and values) present in any VMap data.
MAPKEYSINFO
Returns virtual column information from a given map.
MAPLOOKUP
Returns single-key values from VMAP data.
MAPPUT
Accepts a VMap and one or more key/value pairs and returns a new VMap with the key/value pairs added.
MAPREGEXEXTRACTOR
Extracts data from a regular expression and returns the results as a VMap.
MAPSIZE
Returns the number of virtual columns present in any VMap data.
MAPTOSTRING
Recursively builds a string representation VMap data, including nested JSON maps.
MAPVALUES
Returns a string representation of the top-level values from a VMap.
MAPVERSION
Returns the version or invalidity of any map data.
MARK_DESIGN_KSAFE
Enables or disables high availability in your environment, in case of a failure.
MATERIALIZE_FLEXTABLE_COLUMNS
Materializes virtual columns listed as key_names in the flextable_keys table you compute using either COMPUTE_FLEXTABLE_KEYS or COMPUTE_FLEXTABLE_KEYS_AND_BUILD_VIEW .
MEASURE_LOCATION_PERFORMANCE
Measures disk performance for the location specified.
MOVE_PARTITIONS_TO_TABLE
Moves partitions from one table to another.
MOVE_RETIRED_LOCATION_DATA
Moves all data from either a single retired storage location or all retired storage locations in the database.
MOVE_STATEMENT_TO_RESOURCE_POOL
Attempts to move the specified query to the specified target pool.
NOTIFY
Specifies the text message to include with a notification.
PARTITION_PROJECTION
Splits ROS containers for a specified projection.
PARTITION_TABLE
Forces the database to split ROS containers in the specified table that contain multiple distinct values of the partitioning expression.
PURGE
Permanently removes delete vectors from ROS storage containers so disk space can be reused.
PURGE_PARTITION
Purges a table partition of deleted rows.
PURGE_PROJECTION
Permanently removes deleted data from physical storage so disk space can be reused.
PURGE_TABLE
Permanently removes deleted data from physical storage so disk space can be reused.
READ_CONFIG_FILE
Reads and returns the key-value pairs of all the parameters of a given tokenizer.
REALIGN_CONTROL_NODES
Chooses control nodes (spread hosts) from all cluster nodes and assigns the rest of the nodes in the cluster to a control node.
REBALANCE_CLUSTER
Rebalances the database cluster synchronously as a session foreground task.
REBALANCE_TABLE
Synchronously rebalances data in the specified table.
REENABLE_DUPLICATE_KEY_ERROR
Restores the default behavior of error reporting by reversing the effects of DISABLE_DUPLICATE_KEY_ERROR .
REFRESH
Performs a synchronous, optionally-targeted refresh of a specified table's projections.
REFRESH_COLUMNS
Refreshes table columns that are defined with the constraint SET USING .
RELEASE_ALL_JVM_MEMORY
Forces all sessions to release the memory consumed by their Java Virtual Machines (JVM).
RELEASE_JVM_MEMORY
Terminates a Java Virtual Machine (JVM), making available the memory the JVM was using.
RELOAD_SPREAD
Updates cluster changes to the catalog's spread configuration file.
RESERVE_SESSION_RESOURCE
Reserves memory resources from the general resource pool for the exclusive use of the backup and restore process.
RESET_LOAD_BALANCE_POLICY
Resets the counter each host in the cluster maintains, to track which host it will refer a client to when the native connection load balancing scheme is set to ROUNDROBIN .
RESET_SESSION
Applies your default connection string configuration settings to your current session.
RESTORE_FLEXTABLE_DEFAULT_KEYS_TABLE_AND_VIEW
Restores the _keys table and the _view .
RESTORE_LOCATION
Restores a storage location that was previously retired with RETIRE_LOCATION .
RETIRE_LOCATION
Makes the specified storage location inactive.
S3
Identifies the source location of files in an Amazon S3 bucket.
S3EXPORT
Exports data to an Amazon S3 bucket from your cluster.
SET_AHM_EPOCH
Sets the Ancient History Mark (AHM) to the specified epoch.
SET_AHM_TIME
Sets the Ancient History Mark (AHM) to the epoch corresponding to the specified time on the initiator node.
SET_AUDIT_TIME
Sets the time that performs automatic database size audit to determine if the size of the database is compliant with the raw data allowance in your license.
SET_CLIENT_LABEL
Assigns a label to a client connection for the current session.
SET_CONFIG_PARAMETER
Specifies the value of a configuration parameter at the database level, or for a specific node.
SET_CONTROL_SET_SIZE
Specifies the number of cluster nodes on which to deploy control messaging (spread).
SET_DATA_COLLECTOR_POLICY
Sets a size restraint (memory and disk space in kilobytes) for the specified Data Collector table on all nodes.
SET_DATA_COLLECTOR_TIME_POLICY
Sets a time capacity for individual Data Collector tables on all nodes.
SET_LOAD_BALANCE_POLICY
Sets how native connection load balancing chooses a host to handle a client connection.
SET_LOCATION_PERFORMANCE
Sets disk performance for the location specified.
SET_OBJECT_STORAGE_POLICY
Creates or changes an object storage policy by associating a database object with a labeled storage location.
SET_SCALING_FACTOR
Sets the scaling factor that determines the number of storage containers used when rebalancing the database and when using local data segmentation is enabled.
SET_TOKENIZER_PARAMETER
Configures the tokenizer parameters.
SHOW_PROFILING_CONFIG
Shows whether profiling is enabled.
SHUTDOWN
Forces a database to shut down, even if there are users connected.
SLEEP
Waits a specified number of seconds before executing another statement or command.
START_REBALANCE_CLUSTER
Asynchronously rebalances the database cluster as a background task.
START_REFRESH
For the current schema, transfers data to projections that are not able to participate in query execution due to missing or out-of-date data.
SWAP_PARTITIONS_BETWEEN_TABLES
Swaps partitions between two tables.
SYNC_WITH_HCATALOG_SCHEMA
Copies the structure of a Hive database schema available through the HCatalog Connector to a schema.
SYNC_WITH_HCATALOG_SCHEMA_TABLE
Copies the structure of a single table in a Hive database schema available through the HCatalog Connector to a table.
VALIDATE_STATISTICS
Validates statistics in the XML file generated by the EXPORT_STATISTICS command.
VERIFY_HADOOP_CONF_DIR
Verifies that the Hadoop configuration that is used to access HDFS is valid on all nodes.