http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/HDFSConfigurationParameterReference.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/HDFSConfigurationParameterReference.html.md.erb b/markdown/reference/HDFSConfigurationParameterReference.html.md.erb new file mode 100644 index 0000000..aef4ed2 --- /dev/null +++ b/markdown/reference/HDFSConfigurationParameterReference.html.md.erb @@ -0,0 +1,257 @@ +--- +title: HDFS Configuration Reference +--- + +This reference page describes HDFS configuration values that are configured for HAWQ either within `hdfs-site.xml`, `core-site.xml`, or `hdfs-client.xml`. + +## <a id="topic_ixj_xw1_1w"></a>HDFS Site Configuration (hdfs-site.xml and core-site.xml) + +This topic provides a reference of the HDFS site configuration values recommended for HAWQ installations. These parameters are located in either `hdfs-site.xml` or `core-site.xml` of your HDFS deployment. + +This table describes the configuration parameters and values that are recommended for HAWQ installations. Only HDFS parameters that need to be modified or customized for HAWQ are listed. + +| Parameter | Description | Recommended Value for HAWQ Installs | Comments | +|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `dfs.allow.truncate` | Allows truncate. | true | HAWQ requires that you enable `dfs.allow.truncate`. The HAWQ service will fail to start if `dfs.allow.truncate` is not set to `true`. | +| `dfs.block.access.token.enable` | If `true`, access tokens are used as capabilities for accessing DataNodes. If `false`, no access tokens are checked on accessing DataNodes. | *false* for an unsecured HDFS cluster, or *true* for a secure cluster |  | +| `dfs.block.local-path-access.user` | Comma separated list of the users allowed to open block files on legacy short-circuit local read. | gpadmin |  | +| `dfs.client.read.shortcircuit` | This configuration parameter turns on short-circuit local reads. | true | In Ambari, this parameter corresponds to **HDFS Short-circuit read**. The value for this parameter should be the same in `hdfs-site.xml` and HAWQ's `hdfs-client.xml`. | +| `dfs.client.socket-timeout` | The amount of time before a client connection times out when establishing a connection or reading. The value is expressed in milliseconds. | 300000000 |  | +| `dfs.client.use.legacy.blockreader.local` | Setting this value to false specifies that the new version of the short-circuit reader is used. Setting this value to true means that the legacy short-circuit reader would be used. | false |  | +| `dfs.datanode.data.dir.perm` | Permissions for the directories on on the local filesystem where the DFS DataNode stores its blocks. The permissions can either be octal or symbolic. | 750 | In Ambari, this parameter corresponds to **DataNode directories permission** | +| `dfs.datanode.handler.count` | The number of server threads for the DataNode. | 60 |  | +| `dfs.datanode.max.transfer.threads` | Specifies the maximum number of threads to use for transferring data in and out of the DataNode. | 40960 | In Ambari, this parameter corresponds to **DataNode max data transfer threads** | +| `dfs.datanode.socket.write.timeout` | The amount of time before a write operation times out, expressed in milliseconds. | 7200000 |  | +| `dfs.domain.socket.path` | (Optional.) The path to a UNIX domain socket to use for communication between the DataNode and local HDFS clients. If the string "\_PORT" is present in this path, it is replaced by the TCP port of the DataNode. |  | If set, the value for this parameter should be the same in `hdfs-site.xml` and HAWQ's `hdfs-client.xml`. | +| `dfs.namenode.accesstime.precision` | The access time for HDFS file is precise up to this value. Setting a value of 0 disables access times for HDFS. | 0 | In Ambari, this parameter corresponds to **Access time precision** | +| `dfs.namenode.handler.count` | The number of server threads for the NameNode. | 600 |  | +| `dfs.support.append` | Whether HDFS is allowed to append to files. | true |  | +| `ipc.client.connection.maxidletime` | The maximum time in milliseconds after which a client will bring down the connection to the server. | 3600000 | In core-site.xml | +| `ipc.client.connect.timeout` | Indicates the number of milliseconds a client will wait for the socket to establish a server connection. | 300000 | In core-site.xml | +| `ipc.server.listen.queue.size` | Indicates the length of the listen queue for servers accepting client connections. | 3300 | In core-site.xml | + +## <a id="topic_l1c_zw1_1w"></a>HDFS Client Configuration (hdfs-client.xml) + +This topic provides a reference of the HAWQ configuration values located in `$GPHOME/etc/hdfs-client.xml`. + +This table describes the configuration parameters and their default values: + +<table> +<colgroup> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +</colgroup> +<thead> +<tr class="header"> +<th>Parameter</th> +<th>Description</th> +<th>Default Value</th> +<th>Comments</th> +</tr> +</thead> +<tbody> +<tr class="odd"> +<td><code class="ph codeph">dfs.client.failover.max.attempts</code></td> +<td>The maximum number of times that the DFS client retries issuing a RPC call when multiple NameNodes are configured.</td> +<td>15</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">dfs.client.log.severity</code></td> +<td>The minimal log severity level. Valid values include: FATAL, ERROR, INFO, DEBUG1, DEBUG2, and DEBUG3.</td> +<td>INFO</td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">dfs.client.read.shortcircuit</code></td> +<td>Determines whether the DataNode is bypassed when reading file blocks, if the block and client are on the same node. The default value, true, bypasses the DataNode.</td> +<td>true</td> +<td>The value for this parameter should be the same in <code class="ph codeph">hdfs-site.xml</code> and HAWQ's <code class="ph codeph">hdfs-client.xml</code>.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">dfs.client.use.legacy.blockreader.local</code></td> +<td>Determines whether the legacy short-circuit reader implementation, based on HDFS-2246, is used. Set this property to true on non-Linux platforms that do not have the new implementation based on HDFS-347.</td> +<td>false</td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">dfs.default.blocksize</code></td> +<td>Default block size, in bytes.</td> +<td>134217728</td> +<td>Default is equivalent to 128 MB. </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">dfs.default.replica</code></td> +<td>The default number of replicas.</td> +<td>3</td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">dfs.domain.socket.path</code></td> +<td>(Optional.) The path to a UNIX domain socket to use for communication between the DataNode and local HDFS clients. If the string "_PORT" is present in this path, it is replaced by the TCP port of the DataNode.</td> +<td> </td> +<td>If set, the value for this parameter should be the same in <code class="ph codeph">hdfs-site.xml</code> and HAWQ's <code class="ph codeph">hdfs-client.xml</code>.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">dfs.prefetchsize</code></td> +<td>The number of blocks for which information is pre-fetched.</td> +<td>10</td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">hadoop.security.authentication</code></td> +<td>Specifies the type of RPC authentication to use. A value of <code class="ph codeph">simple</code> indicates no authentication. A value of <code class="ph codeph">kerberos</code> enables authentication by Kerberos.</td> +<td>simple</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">input.connect.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the input stream is setting up a connection to a DataNode.</td> +<td>600000</td> +<td> Default is equal to 1 hour.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">input.localread.blockinfo.cachesize</code></td> +<td>The size of the file block path information cache, in bytes.</td> +<td>1000</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">input.localread.default.buffersize</code></td> +<td>The size of the buffer, in bytes, used to hold data from the file block and verify the checksum. This value is used only when <code class="ph codeph">dfs.client.read.shortcircuit</code> is set to true.</td> +<td>1048576</td> +<td>Default is equal to 1MB. Only used when is set to true. +<p>If an older version of <code class="ph codeph">hdfs-client.xml</code> is retained during upgrade, to avoid performance degradation, set the <code class="ph codeph">input.localread.default.buffersize</code> to 2097152. </p></td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">input.read.getblockinfo.retry</code></td> +<td>The maximum number of times the client should retry getting block information from the NameNode.</td> +<td>3</td> +<td></td> +</tr> +<tr class="even"> +<td><code class="ph codeph">input.read.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the input stream is reading from a DataNode.</td> +<td>3600000</td> +<td>Default is equal to 1 hour.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">input.write.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the input stream is writing to a DataNode.</td> +<td>3600000</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">output.close.timeout</code></td> +<td>The timeout interval for closing an output stream, in milliseconds.</td> +<td>900000</td> +<td>Default is equal to 1.5 hours.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">output.connect.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the output stream is setting up a connection to a DataNode.</td> +<td>600000</td> +<td>Default is equal to 10 minutes.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">output.default.chunksize</code></td> +<td>The chunk size of the pipeline, in bytes.</td> +<td>512</td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">output.default.packetsize</code></td> +<td>The packet size of the pipeline, in bytes.</td> +<td>65536</td> +<td>Default is equal to 64KB. </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">output.default.write.retry</code></td> +<td>The maximum number of times that the client should reattempt to set up a failed pipeline.</td> +<td>10</td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">output.packetpool.size</code></td> +<td>The maximum number of packets in a file's packet pool.</td> +<td>1024</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">output.read.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the output stream is reading from a DataNode.</td> +<td>3600000</td> +<td>Default is equal to 1 hour. </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">output.replace-datanode-on-failure</code></td> +<td>Determines whether the client adds a new DataNode to pipeline if the number of nodes in the pipeline is less than the specified number of replicas.</td> +<td>false (if # of nodes less than or equal to 4), otherwise true</td> +<td>When you deploy a HAWQ cluster, the <code class="ph codeph">hawq init</code> utility detects the number of nodes in the cluster and updates this configuration parameter accordingly. However, when expanding an existing cluster to 4 or more nodes, you must manually set this value to true. Set to false if you remove existing nodes and fall under 4 nodes.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">output.write.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the output stream is writing to a DataNode.</td> +<td>3600000</td> +<td>Default is equal to 1 hour.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">rpc.client.connect.retry</code></td> +<td>The maximum number of times to retry a connection if the RPC client fails connect to the server.</td> +<td>10</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">rpc.client.connect.tcpnodelay</code></td> +<td>Determines whether TCP_NODELAY is used when connecting to the RPC server.</td> +<td>true</td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">rpc.client.connect.timeout</code></td> +<td>The timeout interval for establishing the RPC client connection, in milliseconds.</td> +<td>600000</td> +<td>Default equals 10 minutes.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">rpc.client.max.idle</code></td> +<td>The maximum idle time for an RPC connection, in milliseconds.</td> +<td>10000</td> +<td>Default equals 10 seconds.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">rpc.client.ping.interval</code></td> +<td>The interval which the RPC client send a heart beat to server. 0 means disable.</td> +<td>10000</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">rpc.client.read.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the RPC client is reading from the server.</td> +<td>3600000</td> +<td>Default equals 1 hour.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">rpc.client.socket.linger.timeout</code></td> +<td>The value to set for the SO_LINGER socket when connecting to the RPC server.</td> +<td>-1</td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">rpc.client.timeout</code></td> +<td>The timeout interval of an RPC invocation, in milliseconds.</td> +<td>3600000</td> +<td>Default equals 1 hour.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">rpc.client.write.timeout</code></td> +<td>The timeout interval, in milliseconds, for when the RPC client is writing to the server.</td> +<td>3600000</td> +<td>Default equals 1 hour.</td> +</tr> +</tbody> +</table> + +
http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/SQLCommandReference.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/SQLCommandReference.html.md.erb b/markdown/reference/SQLCommandReference.html.md.erb new file mode 100644 index 0000000..7bbe625 --- /dev/null +++ b/markdown/reference/SQLCommandReference.html.md.erb @@ -0,0 +1,163 @@ +--- +title: SQL Commands +--- + +This section contains a description and the syntax of the SQL commands supported by HAWQ. + +- **[ABORT](../reference/sql/ABORT.html)** + +- **[ALTER AGGREGATE](../reference/sql/ALTER-AGGREGATE.html)** + +- **[ALTER DATABASE](../reference/sql/ALTER-DATABASE.html)** + +- **[ALTER FUNCTION](../reference/sql/ALTER-FUNCTION.html)** + +- **[ALTER OPERATOR](../reference/sql/ALTER-OPERATOR.html)** + +- **[ALTER OPERATOR CLASS](../reference/sql/ALTER-OPERATOR-CLASS.html)** + +- **[ALTER RESOURCE QUEUE](../reference/sql/ALTER-RESOURCE-QUEUE.html)** + +- **[ALTER ROLE](../reference/sql/ALTER-ROLE.html)** + +- **[ALTER TABLE](../reference/sql/ALTER-TABLE.html)** + +- **[ALTER TABLESPACE](../reference/sql/ALTER-TABLESPACE.html)** + +- **[ALTER TYPE](../reference/sql/ALTER-TYPE.html)** + +- **[ALTER USER](../reference/sql/ALTER-USER.html)** + +- **[ANALYZE](../reference/sql/ANALYZE.html)** + +- **[BEGIN](../reference/sql/BEGIN.html)** + +- **[CHECKPOINT](../reference/sql/CHECKPOINT.html)** + +- **[CLOSE](../reference/sql/CLOSE.html)** + +- **[COMMIT](../reference/sql/COMMIT.html)** + +- **[COPY](../reference/sql/COPY.html)** + +- **[CREATE AGGREGATE](../reference/sql/CREATE-AGGREGATE.html)** + +- **[CREATE DATABASE](../reference/sql/CREATE-DATABASE.html)** + +- **[CREATE EXTERNAL TABLE](../reference/sql/CREATE-EXTERNAL-TABLE.html)** + +- **[CREATE FUNCTION](../reference/sql/CREATE-FUNCTION.html)** + +- **[CREATE GROUP](../reference/sql/CREATE-GROUP.html)** + +- **[CREATE LANGUAGE](../reference/sql/CREATE-LANGUAGE.html)** + +- **[CREATE OPERATOR](../reference/sql/CREATE-OPERATOR.html)** + +- **[CREATE OPERATOR CLASS](../reference/sql/CREATE-OPERATOR-CLASS.html)** + +- **[CREATE RESOURCE QUEUE](../reference/sql/CREATE-RESOURCE-QUEUE.html)** + +- **[CREATE ROLE](../reference/sql/CREATE-ROLE.html)** + +- **[CREATE SCHEMA](../reference/sql/CREATE-SCHEMA.html)** + +- **[CREATE SEQUENCE](../reference/sql/CREATE-SEQUENCE.html)** + +- **[CREATE TABLE](../reference/sql/CREATE-TABLE.html)** + +- **[CREATE TABLE AS](../reference/sql/CREATE-TABLE-AS.html)** + +- **[CREATE TABLESPACE](../reference/sql/CREATE-TABLESPACE.html)** + +- **[CREATE TYPE](../reference/sql/CREATE-TYPE.html)** + +- **[CREATE USER](../reference/sql/CREATE-USER.html)** + +- **[CREATE VIEW](../reference/sql/CREATE-VIEW.html)** + +- **[DEALLOCATE](../reference/sql/DEALLOCATE.html)** + +- **[DECLARE](../reference/sql/DECLARE.html)** + +- **[DROP AGGREGATE](../reference/sql/DROP-AGGREGATE.html)** + +- **[DROP DATABASE](../reference/sql/DROP-DATABASE.html)** + +- **[DROP EXTERNAL TABLE](../reference/sql/DROP-EXTERNAL-TABLE.html)** + +- **[DROP FILESPACE](../reference/sql/DROP-FILESPACE.html)** + +- **[DROP FUNCTION](../reference/sql/DROP-FUNCTION.html)** + +- **[DROP GROUP](../reference/sql/DROP-GROUP.html)** + +- **[DROP OPERATOR](../reference/sql/DROP-OPERATOR.html)** + +- **[DROP OPERATOR CLASS](../reference/sql/DROP-OPERATOR-CLASS.html)** + +- **[DROP OWNED](../reference/sql/DROP-OWNED.html)** + +- **[DROP RESOURCE QUEUE](../reference/sql/DROP-RESOURCE-QUEUE.html)** + +- **[DROP ROLE](../reference/sql/DROP-ROLE.html)** + +- **[DROP SCHEMA](../reference/sql/DROP-SCHEMA.html)** + +- **[DROP SEQUENCE](../reference/sql/DROP-SEQUENCE.html)** + +- **[DROP TABLE](../reference/sql/DROP-TABLE.html)** + +- **[DROP TABLESPACE](../reference/sql/DROP-TABLESPACE.html)** + +- **[DROP TYPE](../reference/sql/DROP-TYPE.html)** + +- **[DROP USER](../reference/sql/DROP-USER.html)** + +- **[DROP VIEW](../reference/sql/DROP-VIEW.html)** + +- **[END](../reference/sql/END.html)** + +- **[EXECUTE](../reference/sql/EXECUTE.html)** + +- **[EXPLAIN](../reference/sql/EXPLAIN.html)** + +- **[FETCH](../reference/sql/FETCH.html)** + +- **[GRANT](../reference/sql/GRANT.html)** + +- **[INSERT](../reference/sql/INSERT.html)** + +- **[PREPARE](../reference/sql/PREPARE.html)** + +- **[REASSIGN OWNED](../reference/sql/REASSIGN-OWNED.html)** + +- **[RELEASE SAVEPOINT](../reference/sql/RELEASE-SAVEPOINT.html)** + +- **[RESET](../reference/sql/RESET.html)** + +- **[REVOKE](../reference/sql/REVOKE.html)** + +- **[ROLLBACK](../reference/sql/ROLLBACK.html)** + +- **[ROLLBACK TO SAVEPOINT](../reference/sql/ROLLBACK-TO-SAVEPOINT.html)** + +- **[SAVEPOINT](../reference/sql/SAVEPOINT.html)** + +- **[SELECT](../reference/sql/SELECT.html)** + +- **[SELECT INTO](../reference/sql/SELECT-INTO.html)** + +- **[SET](../reference/sql/SET.html)** + +- **[SET ROLE](../reference/sql/SET-ROLE.html)** + +- **[SET SESSION AUTHORIZATION](../reference/sql/SET-SESSION-AUTHORIZATION.html)** + +- **[SHOW](../reference/sql/SHOW.html)** + +- **[TRUNCATE](../reference/sql/TRUNCATE.html)** + +- **[VACUUM](../reference/sql/VACUUM.html)** + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/catalog_ref-html.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/catalog_ref-html.html.md.erb b/markdown/reference/catalog/catalog_ref-html.html.md.erb new file mode 100644 index 0000000..864f106 --- /dev/null +++ b/markdown/reference/catalog/catalog_ref-html.html.md.erb @@ -0,0 +1,143 @@ +--- +title: System Catalogs Definitions +--- + +System catalog table and view definitions in alphabetical order. + +- **[gp\_configuration\_history](../../reference/catalog/gp_configuration_history.html)** + +- **[gp\_distribution\_policy](../../reference/catalog/gp_distribution_policy.html)** + +- **[gp\_global\_sequence](../../reference/catalog/gp_global_sequence.html)** + +- **[gp\_master\_mirroring](../../reference/catalog/gp_master_mirroring.html)** + +- **[gp\_persistent\_database\_node](../../reference/catalog/gp_persistent_database_node.html)** + +- **[gp\_persistent\_filespace\_node](../../reference/catalog/gp_persistent_filespace_node.html)** + +- **[gp\_persistent\_relation\_node](../../reference/catalog/gp_persistent_relation_node.html)** + +- **[gp\_persistent\_relfile\_node](../../reference/catalog/gp_persistent_relfile_node.html)** + +- **[gp\_persistent\_tablespace\_node](../../reference/catalog/gp_persistent_tablespace_node.html)** + +- **[gp\_relfile\_node](../../reference/catalog/gp_relfile_node.html)** + +- **[gp\_segment\_configuration](../../reference/catalog/gp_segment_configuration.html)** + +- **[gp\_version\_at\_initdb](../../reference/catalog/gp_version_at_initdb.html)** + +- **[pg\_aggregate](../../reference/catalog/pg_aggregate.html)** + +- **[pg\_am](../../reference/catalog/pg_am.html)** + +- **[pg\_amop](../../reference/catalog/pg_amop.html)** + +- **[pg\_amproc](../../reference/catalog/pg_amproc.html)** + +- **[pg\_appendonly](../../reference/catalog/pg_appendonly.html)** + +- **[pg\_attrdef](../../reference/catalog/pg_attrdef.html)** + +- **[pg\_attribute](../../reference/catalog/pg_attribute.html)** + +- **[pg\_attribute\_encoding](../../reference/catalog/pg_attribute_encoding.html)** + +- **[pg\_auth\_members](../../reference/catalog/pg_auth_members.html)** + +- **[pg\_authid](../../reference/catalog/pg_authid.html)** + +- **[pg\_cast](../../reference/catalog/pg_cast.html)** + +- **[pg\_class](../../reference/catalog/pg_class.html)** + +- **[pg\_compression](../../reference/catalog/pg_compression.html)** + +- **[pg\_constraint](../../reference/catalog/pg_constraint.html)** + +- **[pg\_conversion](../../reference/catalog/pg_conversion.html)** + +- **[pg\_database](../../reference/catalog/pg_database.html)** + +- **[pg\_depend](../../reference/catalog/pg_depend.html)** + +- **[pg\_description](../../reference/catalog/pg_description.html)** + +- **[pg\_exttable](../../reference/catalog/pg_exttable.html)** + +- **[pg\_filespace](../../reference/catalog/pg_filespace.html)** + +- **[pg\_filespace\_entry](../../reference/catalog/pg_filespace_entry.html)** + +- **[pg\_index](../../reference/catalog/pg_index.html)** + +- **[pg\_inherits](../../reference/catalog/pg_inherits.html)** + +- **[pg\_language](../../reference/catalog/pg_language.html)** + +- **[pg\_largeobject](../../reference/catalog/pg_largeobject.html)** + +- **[pg\_listener](../../reference/catalog/pg_listener.html)** + +- **[pg\_locks](../../reference/catalog/pg_locks.html)** + +- **[pg\_namespace](../../reference/catalog/pg_namespace.html)** + +- **[pg\_opclass](../../reference/catalog/pg_opclass.html)** + +- **[pg\_operator](../../reference/catalog/pg_operator.html)** + +- **[pg\_partition](../../reference/catalog/pg_partition.html)** + +- **[pg\_partition\_columns](../../reference/catalog/pg_partition_columns.html)** + +- **[pg\_partition\_encoding](../../reference/catalog/pg_partition_encoding.html)** + +- **[pg\_partition\_rule](../../reference/catalog/pg_partition_rule.html)** + +- **[pg\_partition\_templates](../../reference/catalog/pg_partition_templates.html)** + +- **[pg\_partitions](../../reference/catalog/pg_partitions.html)** + +- **[pg\_pltemplate](../../reference/catalog/pg_pltemplate.html)** + +- **[pg\_proc](../../reference/catalog/pg_proc.html)** + +- **[pg\_resqueue](../../reference/catalog/pg_resqueue.html)** + +- **[pg\_resqueue\_status](../../reference/catalog/pg_resqueue_status.html)** + +- **[pg\_rewrite](../../reference/catalog/pg_rewrite.html)** + +- **[pg\_roles](../../reference/catalog/pg_roles.html)** + +- **[pg\_shdepend](../../reference/catalog/pg_shdepend.html)** + +- **[pg\_shdescription](../../reference/catalog/pg_shdescription.html)** + +- **[pg\_stat\_activity](../../reference/catalog/pg_stat_activity.html)** + +- **[pg\_stat\_last\_operation](../../reference/catalog/pg_stat_last_operation.html)** + +- **[pg\_stat\_last\_shoperation](../../reference/catalog/pg_stat_last_shoperation.html)** + +- **[pg\_stat\_operations](../../reference/catalog/pg_stat_operations.html)** + +- **[pg\_stat\_partition\_operations](../../reference/catalog/pg_stat_partition_operations.html)** + +- **[pg\_statistic](../../reference/catalog/pg_statistic.html)** + +- **[pg\_stats](../../reference/catalog/pg_stats.html)** + +- **[pg\_tablespace](../../reference/catalog/pg_tablespace.html)** + +- **[pg\_trigger](../../reference/catalog/pg_trigger.html)** + +- **[pg\_type](../../reference/catalog/pg_type.html)** + +- **[pg\_type\_encoding](../../reference/catalog/pg_type_encoding.html)** + +- **[pg\_window](../../reference/catalog/pg_window.html)** + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/catalog_ref-tables.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/catalog_ref-tables.html.md.erb b/markdown/reference/catalog/catalog_ref-tables.html.md.erb new file mode 100644 index 0000000..61aa936 --- /dev/null +++ b/markdown/reference/catalog/catalog_ref-tables.html.md.erb @@ -0,0 +1,68 @@ +--- +title: System Tables +--- + +This topic lists the system tables included in HAWQ. + +- gp\_configuration (Deprecated. See [gp\_segment\_configuration](gp_segment_configuration.html#topic1).) +- [gp\_configuration\_history](gp_configuration_history.html#topic1) +- [gp\_distribution\_policy](gp_distribution_policy.html#topic1) +- [gp\_global\_sequence](gp_global_sequence.html#topic1) +- [gp\_master\_mirroring](gp_master_mirroring.html#topic1) +- [gp\_persistent\_database\_node](gp_persistent_database_node.html#topic1) +- [gp\_persistent\_filespace\_node](gp_persistent_filespace_node.html#topic1) +- [gp\_persistent\_relation\_node](gp_persistent_relation_node.html#topic1) +- [gp\_persistent\_tablespace\_node](gp_persistent_tablespace_node.html#topic1) +- gp\_relation\_node (Deprecated. See [gp\_relfile\_node](gp_relfile_node.html).) +- [gp\_segment\_configuration](gp_segment_configuration.html#topic1) +- [gp\_version\_at\_initdb](gp_version_at_initdb.html#topic1) +- [pg\_aggregate](pg_aggregate.html#topic1) +- [pg\_am](pg_am.html#topic1) +- [pg\_amop](pg_amop.html#topic1) +- [pg\_amproc](pg_amproc.html#topic1) +- [pg\_appendonly](pg_appendonly.html#topic1) +- [pg\_attrdef](pg_attrdef.html#topic1) +- [pg\_attribute](pg_attribute.html#topic1) +- [pg\_auth\_members](pg_auth_members.html#topic1) +- [pg\_authid](pg_authid.html#topic1) +- pg\_autovacuum (not supported) +- [pg\_cast](pg_cast.html#topic1) +- [pg\_class](pg_class.html#topic1) +- [pg\_constraint](pg_constraint.html#topic1) +- [pg\_conversion](pg_conversion.html#topic1) +- [pg\_database](pg_database.html#topic1) +- [pg\_depend](pg_depend.html#topic1) +- [pg\_description](pg_description.html#topic1) +- [pg\_exttable](pg_exttable.html#topic1) +- [pg\_filespace](pg_filespace.html#topic1) +- [pg\_filespace\_entry](pg_filespace_entry.html#topic1) +- pg\_foreign\_data\_wrapper (not supported) +- pg\_foreign\_server (not supported) +- pg\_foreign\_table (not supported) +- [pg\_index](pg_index.html#topic1) +- [pg\_inherits](pg_inherits.html#topic1) +- [pg\_language](pg_language.html#topic1) +- [pg\_largeobject](pg_largeobject.html#topic1) +- [pg\_listener](pg_listener.html#topic1) +- [pg\_namespace](pg_namespace.html#topic1) +- [pg\_opclass](pg_opclass.html#topic1) +- [pg\_operator](pg_operator.html#topic1) +- [pg\_partition](pg_partition.html#topic1) +- [pg\_partition\_rule](pg_partition_rule.html#topic1) +- [pg\_pltemplate](pg_pltemplate.html#topic1) +- [pg\_proc](pg_proc.html#topic1) +- [pg\_resqueue](pg_resqueue.html#topic1) +- [pg\_rewrite](pg_rewrite.html#topic1) +- [pg\_shdepend](pg_shdepend.html#topic1) +- [pg\_shdescription](pg_shdescription.html#topic1) +- [pg\_stat\_last\_operation](pg_stat_last_operation.html#topic1) +- [pg\_stat\_last\_shoperation](pg_stat_last_shoperation.html#topic1) +- [pg\_statistic](pg_statistic.html#topic1) +- [pg\_stats](pg_stats.html#topic1) +- [pg\_tablespace](pg_tablespace.html#topic1) +- [pg\_trigger](pg_trigger.html#topic1) +- [pg\_type](pg_type.html#topic1) +- pg\_user\_mapping (not supported) +- [pg\_window](pg_window.html#topic1) + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/catalog_ref-views.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/catalog_ref-views.html.md.erb b/markdown/reference/catalog/catalog_ref-views.html.md.erb new file mode 100644 index 0000000..4a7ad74 --- /dev/null +++ b/markdown/reference/catalog/catalog_ref-views.html.md.erb @@ -0,0 +1,21 @@ +--- +title: System Views +--- + +HAWQ provides the following system views not available in PostgreSQL. + +- pg\_max\_external\_files (shows number of external table files allowed per segment host when using the file:// protocol) +- [pg\_partition\_columns](pg_partition_columns.html#topic1) +- [pg\_partition\_templates](pg_partition_templates.html#topic1) +- [pg\_partitions](pg_partitions.html#topic1) +- [pg\_stat\_activity](pg_stat_activity.html#topic1) +- [pg\_resqueue\_status](pg_resqueue_status.html#topic1) +- [pg\_stats](pg_stats.html#topic1) + +For more information about the standard system views supported in PostgreSQL and HAWQ, see the following sections of the PostgreSQL documentation: + +- [System Views](http://www.postgresql.org/docs/8.2/static/views-overview.html) +- [Statistics Collector Views](http://www.postgresql.org/docs/8.2/static/monitoring-stats.html#MONITORING-STATS-VIEWS-TABLE) +- [The Information Schema](http://www.postgresql.org/docs/8.2/static/information-schema.html) + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/catalog_ref.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/catalog_ref.html.md.erb b/markdown/reference/catalog/catalog_ref.html.md.erb new file mode 100644 index 0000000..143091f --- /dev/null +++ b/markdown/reference/catalog/catalog_ref.html.md.erb @@ -0,0 +1,21 @@ +--- +title: System Catalog Reference +--- + +This reference describes the HAWQ system catalog tables and views. + +System tables prefixed with '`gp_`' relate to the parallel features of HAWQ. Tables prefixed with '`pg_`' are either standard PostgreSQL system catalog tables supported in HAWQ, or are related to features HAWQ that provides to enhance PostgreSQL for data warehousing workloads. Note that the global system catalog for HAWQ resides on the master instance. + +- **[System Tables](../../reference/catalog/catalog_ref-tables.html)** + + This topic lists the system tables included in HAWQ. + +- **[System Views](../../reference/catalog/catalog_ref-views.html)** + + HAWQ provides the following system views not available in PostgreSQL. + +- **[System Catalogs Definitions](../../reference/catalog/catalog_ref-html.html)** + + System catalog table and view definitions in alphabetical order. + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_configuration_history.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_configuration_history.html.md.erb b/markdown/reference/catalog/gp_configuration_history.html.md.erb new file mode 100644 index 0000000..e501d55 --- /dev/null +++ b/markdown/reference/catalog/gp_configuration_history.html.md.erb @@ -0,0 +1,23 @@ +--- +title: gp_configuration_history +--- + +The `gp_configuration_history` table contains information about system changes related to fault detection and recovery operations. The HAWQ [fault tolerance service](../../admin/FaultTolerance.html) logs data to this table, as do certain related management utilities such as `hawq init`. For example, when you add a new segment to the system, records for these events are logged to `gp_configuration_history`. If a segment is marked as down by the fault tolerance service in the [gp\_segment\_configuration](gp_segment_configuration.html) catalog table, then the reason for being marked as down is recorded in this table. + +The event descriptions stored in this table may be helpful for troubleshooting serious system issues in collaboration with HAWQ support technicians. + +This table is populated only on the master. This table is defined in the `pg_global` tablespace, meaning it is globally shared across all databases in the system. + +<a id="topic1__ev138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_configuration\_history</span> + +| column | type | references | description | +|---------------------|--------------------------|------------|----------------------------------------------------------------------------------| +| `time` | timestamp with time zone |  | Timestamp for the event recorded. | +| `desc` | text |  | Text description of the event. | +| registration\_order | integer |  | The registration order of a segment. May be changed after restarting the master. | +| hostname | text |  | The hostname of a segment | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_distribution_policy.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_distribution_policy.html.md.erb b/markdown/reference/catalog/gp_distribution_policy.html.md.erb new file mode 100644 index 0000000..6b227e6 --- /dev/null +++ b/markdown/reference/catalog/gp_distribution_policy.html.md.erb @@ -0,0 +1,18 @@ +--- +title: gp_distribution_policy +--- + +The `gp_distribution_policy` table contains information about HAWQ tables and their policy for distributing table data across the segments. This table is populated only on the master. This table is not globally shared, meaning each database has its own copy of this table. + +<a id="topic1__ey142842"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_distribution\_policy</span> + +| column | type | references | description | +|-------------|--------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `localoid` | oid | pg\_class.oid | The table object identifier (OID). | +| `attrnums` | smallint\[\] | pg\_attribute.attnum | The column number(s) of the distribution column(s). | +| `bucketnum` | integer |  | Number of hash buckets used in creating a hash-distributed table or for external table intermediate processing. The number of buckets also affects how many virtual segment are created when processing data. | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_global_sequence.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_global_sequence.html.md.erb b/markdown/reference/catalog/gp_global_sequence.html.md.erb new file mode 100644 index 0000000..ac2ff2f --- /dev/null +++ b/markdown/reference/catalog/gp_global_sequence.html.md.erb @@ -0,0 +1,16 @@ +--- +title: gp_global_sequence +--- + +The `gp_global_sequence` table contains the log sequence number position in the transaction log. This table is used by persistent tables. + +<a id="topic1__fe138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_global\_sequence</span> + +| column | type | references | description | +|----------------|--------|------------|-----------------------------------------------------| +| `sequence_num` | bigint |  | Log sequence number position in the transaction log | + +> + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_master_mirroring.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_master_mirroring.html.md.erb b/markdown/reference/catalog/gp_master_mirroring.html.md.erb new file mode 100644 index 0000000..fa7ea18 --- /dev/null +++ b/markdown/reference/catalog/gp_master_mirroring.html.md.erb @@ -0,0 +1,19 @@ +--- +title: gp_master_mirroring +--- + +The `gp_master_mirroring` table contains state information about the standby master host and its associated write-ahead log (WAL) replication process. If this synchronization process (`gpsyncagent`) fails on the standby master, it may not always be noticeable to users of the system. This catalog is a place where HAWQ administrators can check to see if the standby master is current and fully synchronized. + +<a id="topic1__op164584"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_master\_mirroring</span> + +| column | type | references | description | +|-----------------|--------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `summary_state` | text |  | The current state of the log replication process between the master and standby master - logs are either âSynchronizedâ or âNot Synchronizedâ | +| `detail_state` | text |  | If not synchronized, this column will have information about the cause of the error. | +| `log_time` | timestamp with time zone |  | This contains the timestamp of the last time a master mirroring change occurred. For example, the timestamp when the value of `summary_state` changed from "Synchronized" to "Not Synchronized". If no changes occur with regards to the standby master (it stays synchronized), the timestamp is not updated. | +| `error_message` | text |  | If not synchronized, this column will have the error message from the failed synchronization attempt. | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_persistent_database_node.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_persistent_database_node.html.md.erb b/markdown/reference/catalog/gp_persistent_database_node.html.md.erb new file mode 100644 index 0000000..2a3537a --- /dev/null +++ b/markdown/reference/catalog/gp_persistent_database_node.html.md.erb @@ -0,0 +1,71 @@ +--- +title: gp_persistent_database_node +--- + +The `gp_persistent_database_node` table keeps track of the status of file system objects in relation to the transaction status of database objects. This information is used to make sure the state of the system catalogs and the file system files persisted to disk are synchronized. + +<a id="topic1__fi138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_persistent\_database\_node</span> + +<table> +<colgroup> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +</colgroup> +<thead> +<tr class="header"> +<th>column</th> +<th>type</th> +<th>references</th> +<th>description</th> +</tr> +</thead> +<tbody> +<tr class="odd"> +<td><code class="ph codeph">tablespace_oid</code></td> +<td>oid</td> +<td>pg_tablespace.oid</td> +<td>Table space object id.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">database_oid</code></td> +<td>oid</td> +<td>pg_database.oid</td> +<td>Database object id.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">persistent_state</code></td> +<td>smallint</td> +<td> </td> +<td>0 - free +<p>1 - create pending</p> +<p>2 - created</p> +<p>3 - drop pending</p> +<p>4 - aborting create</p> +<p>5 - "Just in Time" create pending</p> +<p>6 - bulk load create pending</p></td> +</tr> +<tr class="even"> +<td><code class="ph codeph">parent_xid</code></td> +<td>integer</td> +<td> </td> +<td>Global transaction id.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">persistent_serial_num</code></td> +<td>bigint</td> +<td> </td> +<td>Log sequence number position in the transaction log for a file block.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">previous_free_tid</code></td> +<td>tid</td> +<td> </td> +<td>Used by HAWQ to internally manage persistent representations of file system objects.</td> +</tr> +</tbody> +</table> + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_persistent_filespace_node.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_persistent_filespace_node.html.md.erb b/markdown/reference/catalog/gp_persistent_filespace_node.html.md.erb new file mode 100644 index 0000000..b682a88 --- /dev/null +++ b/markdown/reference/catalog/gp_persistent_filespace_node.html.md.erb @@ -0,0 +1,83 @@ +--- +title: gp_persistent_filespace_node +--- + +The `gp_persistent_filespace_node` table keeps track of the status of file system objects in relation to the transaction status of filespace objects. This information is used to make sure the state of the system catalogs and the file system files persisted to disk are synchronized. + +<a id="topic1__fj138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_persistent\_filespace\_node</span> + +<table> +<colgroup> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +</colgroup> +<thead> +<tr class="header"> +<th>column</th> +<th>type</th> +<th>references</th> +<th>description</th> +</tr> +</thead> +<tbody> +<tr class="odd"> +<td><code class="ph codeph">filespace_oid</code></td> +<td>oid</td> +<td>pg_filespace.oid</td> +<td>object id of the filespace</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">db_id</code></td> +<td>smallint</td> +<td> </td> +<td>primary segment id</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">location</code></td> +<td>text</td> +<td> </td> +<td>primary filesystem location</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">persistent_state</code></td> +<td>smallint</td> +<td> </td> +<td>0 - free +<p>1 - create pending</p> +<p>2 - created</p> +<p>3 - drop pending</p> +<p>4 - aborting create</p> +<p>5 - "Just in Time" create pending</p> +<p>6 - bulk load create pending</p></td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">reserved</code></td> +<td>integer</td> +<td> </td> +<td>Not used. Reserved for future use.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">parent_xid</code></td> +<td>integer</td> +<td> </td> +<td>Global transaction id.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">persistent_serial_num</code></td> +<td>bigint</td> +<td> </td> +<td>Log sequence number position in the transaction log for a file block.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">previous_free_tid</code></td> +<td>tid</td> +<td> </td> +<td>Used by HAWQ to internally manage persistent representations of file system objects.</td> +</tr> +</tbody> +</table> + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_persistent_relation_node.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_persistent_relation_node.html.md.erb b/markdown/reference/catalog/gp_persistent_relation_node.html.md.erb new file mode 100644 index 0000000..f141cf7 --- /dev/null +++ b/markdown/reference/catalog/gp_persistent_relation_node.html.md.erb @@ -0,0 +1,85 @@ +--- +title: gp_persistent_relation_node +--- + +The `gp_persistent_relation_node` table table keeps track of the status of file system objects in relation to the transaction status of relation objects (tables, view, indexes, and so on). This information is used to make sure the state of the system catalogs and the file system files persisted to disk are synchronized. + +<a id="topic1__fk138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_persistent\_relation\_node</span> + +<table> +<colgroup> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +</colgroup> +<thead> +<tr class="header"> +<th>column</th> +<th>type</th> +<th>references</th> +<th>description</th> +</tr> +</thead> +<tbody> +<tr class="odd"> +<td><code class="ph codeph">tablespace_oid</code></td> +<td>oid</td> +<td>pg_tablespace.oid</td> +<td>Tablespace object id</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">database_oid</code></td> +<td>oid</td> +<td>pg_database.oid</td> +<td>Database object id</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">relfilenode_oid</code></td> +<td>oid</td> +<td>pg_class.relfilenode</td> +<td>The object id of the relation file node.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">persistent_state</code></td> +<td>smallint</td> +<td> </td> +<td>0 - free +<p>1 - create pending</p> +<p>2 - created</p> +<p>3 - drop pending</p> +<p>4 - aborting create</p> +<p>5 - "Just in Time" create pending</p> +<p>6 - bulk load create pending</p></td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">reserved</code></td> +<td>integer</td> +<td> </td> +<td>Unused. Reserved for future use.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">parent_xid</code></td> +<td>integer</td> +<td> </td> +<td>Global transaction id.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">persistent_serial_num</code></td> +<td>bigint</td> +<td> </td> +<td>Log sequence number position in the transaction log for a file block.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">previous_free_tid</code></td> +<td>tid</td> +<td> </td> +<td>Used by HAWQ to internally manage persistent representations of file system objects.</td> +</tr> +</tbody> +</table> + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_persistent_relfile_node.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_persistent_relfile_node.html.md.erb b/markdown/reference/catalog/gp_persistent_relfile_node.html.md.erb new file mode 100644 index 0000000..6d24a41 --- /dev/null +++ b/markdown/reference/catalog/gp_persistent_relfile_node.html.md.erb @@ -0,0 +1,96 @@ +--- +title: gp_persistent_relfile_node +--- + +The `gp_persistent_relfile_node` table keeps track of the status of file system objects in relation to the transaction status of database objects. This information is used to make sure the state of the system catalogs and the file system files persisted to disk are synchronized. + +<a id="topic1__fk138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_persistent\_relfile\_node</span> +<table> +<colgroup> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +</colgroup> +<thead> +<tr class="header"> +<th>column</th> +<th>type</th> +<th>references</th> +<th>description</th> +</tr> +</thead> +<tbody> +<tr class="odd"> +<td><code class="ph codeph">tablespace_oid</code></td> +<td>oid</td> +<td>pg_tablespace.oid</td> +<td>Tablespace object id</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">database_oid</code></td> +<td>oid</td> +<td>pg_database.oid</td> +<td>Database object id</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">relfilenode_oid</code></td> +<td>oid</td> +<td>pg_class.relfilenode</td> +<td>The object id of the relation file node.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">segment_file_num</code></td> +<td>integer</td> +<td> </td> +<td> </td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">relation_storage_manager</code></td> +<td>smallint</td> +<td> </td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">persistent_state</code></td> +<td>smallint</td> +<td> </td> +<td>0 - free +<p>1 - create pending</p> +<p>2 - created</p> +<p>3 - drop pending</p> +<p>4 - aborting create</p> +<p>5 - "Just in Time" create pending</p> +<p>6 - bulk load create pending</p></td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">relation_bufpool_kind</code></td> +<td>integer</td> +<td> </td> +<td> </td> +</tr> +<tr class="even"> +<td><code class="ph codeph">parent_xid</code></td> +<td>integer</td> +<td> </td> +<td>Global transaction id.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">persistent_serial_num</code></td> +<td>bigint</td> +<td> </td> +<td>Log sequence number position in the transaction log for a file block.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">previous_free_tid</code></td> +<td>tid</td> +<td> </td> +<td>Used by HAWQ to internally manage persistent representations of file system objects.</td> +</tr> +</tbody> +</table> + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_persistent_tablespace_node.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_persistent_tablespace_node.html.md.erb b/markdown/reference/catalog/gp_persistent_tablespace_node.html.md.erb new file mode 100644 index 0000000..55c853e --- /dev/null +++ b/markdown/reference/catalog/gp_persistent_tablespace_node.html.md.erb @@ -0,0 +1,72 @@ +--- +title: gp_persistent_tablespace_node +--- + +The `gp_persistent_tablespace_node` table keeps track of the status of file system objects in relation to the transaction status of tablespace objects. This information is used to make sure the state of the system catalogs and the file system files persisted to disk are synchronized. + +<a id="topic1__fm138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_persistent\_tablespace\_node</span> +<table> +<colgroup> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +<col width="25%" /> +</colgroup> +<thead> +<tr class="header"> +<th>column</th> +<th>type</th> +<th>references</th> +<th>description</th> +</tr> +</thead> +<tbody> +<tr class="odd"> +<td><code class="ph codeph">filespace_oid</code></td> +<td>oid</td> +<td>pg_filespace.oid</td> +<td>Filespace object id</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">tablespace_oid</code></td> +<td>oid</td> +<td>pg_tablespace.oid</td> +<td>Tablespace object id</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">persistent_state</code></td> +<td>smallint</td> +<td> </td> +<td>0 - free +<p>1 - create pending</p> +<p>2 - created</p> +<p>3 - drop pending</p> +<p>4 - aborting create</p> +<p>5 - "Just in Time" create pending</p> +<p>6 - bulk load create pending</p></td> +</tr> +<tr class="even"> +<td><code class="ph codeph">parent_xid</code></td> +<td>integer</td> +<td> </td> +<td>Global transaction id.</td> +</tr> +<tr class="odd"> +<td><code class="ph codeph">persistent_serial_num</code></td> +<td>bigint</td> +<td> </td> +<td>Log sequence number position in the transaction log for a file block.</td> +</tr> +<tr class="even"> +<td><code class="ph codeph">previous_free_tid</code></td> +<td>tid</td> +<td> </td> +<td>Used by HAWQ to internally manage persistent representations of file system objects.</td> +</tr> +</tbody> +</table> + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_relfile_node.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_relfile_node.html.md.erb b/markdown/reference/catalog/gp_relfile_node.html.md.erb new file mode 100644 index 0000000..971ff16 --- /dev/null +++ b/markdown/reference/catalog/gp_relfile_node.html.md.erb @@ -0,0 +1,19 @@ +--- +title: gp_relfile_node +--- + +The `gp_relfile_node` table contains information about the file system objects for a relation (table, view, index, and so on). + +<a id="topic1__fo138428"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_relation\_node</span> + +| column | type | references | description | +|-------------------------|---------|-----------------------|--------------------------------------------------------------------------------------| +| `relfilenode_oid` | oid | pg\_class.relfilenode | The object id of the relation file node. | +| `segment_file_num` | integer |  | For append-only tables, the append-only segment file number. | +| `persistent_tid` | tid |  | Used by HAWQ to internally manage persistent representations of file system objects. | +| `persistent_serial_num` | bigint |  | Log sequence number position in the transaction log for a file block. | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_segment_configuration.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_segment_configuration.html.md.erb b/markdown/reference/catalog/gp_segment_configuration.html.md.erb new file mode 100644 index 0000000..9fcf0cb --- /dev/null +++ b/markdown/reference/catalog/gp_segment_configuration.html.md.erb @@ -0,0 +1,25 @@ +--- +title: gp_segment_configuration +--- + +The `gp_segment_configuration` table contains information about master, standby and segment configuration. + +The HAWQ fault tolerance service (FTS) automatically detects the status of individual segments and marks the status of each segment in this table. If a segment is marked as DOWN, the corresponding reason is recorded in the [gp\_configuration\_history](gp_configuration_history.html) table. See [Understanding the Fault Tolerance Service](../../admin/FaultTolerance.html) for a description of the fault tolerance service. + +<a id="topic1__fr163962"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_segment\_configuration</span> + +| column | type | references | description | +|----------------------|---------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `registration_order` | integer |  | When HAWQ starts, the master and each segment starts itself separately. This column indicates the order in which a segment node registers itself to master node. The `registration_order` for segments starts from 1. Master's registration\_order is 0. Standby's registration\_order is -1. | +| `role` | char |  | The role that a node is currently running as. Values are `p` (segment), `m`(master) or `s `(standby). | +| `status` | char |  | The fault status of a segment. Values are `u` (up) or `d` (down). | +| `port` | integer |  | The TCP port the database server listener process is using. | +| `hostname` | text |  | The hostname of a segment host. | +| `address` | text |  | The hostname used to access a particular segment on a segment host. | +| `failed_tmpdir_num` | integer |  | The number of failed temporary directories on the segment. User- configured temporary directories may fail on segments due to disk errors. This information is reported to the master. | +| `failed_tmpdir` | text |  | A list of failed temporary directories on the segment. Multiple failed temporary directories are separated by commas. | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/gp_version_at_initdb.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/gp_version_at_initdb.html.md.erb b/markdown/reference/catalog/gp_version_at_initdb.html.md.erb new file mode 100644 index 0000000..9e922e1 --- /dev/null +++ b/markdown/reference/catalog/gp_version_at_initdb.html.md.erb @@ -0,0 +1,17 @@ +--- +title: gp_version_at_initdb +--- + +The `gp_version_at_initdb` table is populated on the master and each segment in the HAWQ system. It identifies the version of HAWQ used when the system was first initialized. This table is defined in the `pg_global` tablespace, meaning it is globally shared across all databases in the system. + +<a id="topic1__ft142845"></a> +<span class="tablecap">Table 1. pg\_catalog.gp\_version</span> + +| column | type | references | description | +|------------------|---------|------------|-------------------------| +| `schemaversion` | integer |  | Schema version number. | +| `productversion` | text |  | Product version number. | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/pg_aggregate.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/pg_aggregate.html.md.erb b/markdown/reference/catalog/pg_aggregate.html.md.erb new file mode 100644 index 0000000..1a02e89 --- /dev/null +++ b/markdown/reference/catalog/pg_aggregate.html.md.erb @@ -0,0 +1,25 @@ +--- +title: pg_aggregate +--- + +The `pg_aggregate` table stores information about aggregate functions. An aggregate function is a function that operates on a set of values (typically one column from each row that matches a query condition) and returns a single value computed from all these values. Typical aggregate functions are `sum`, `count`, and `max`. Each entry in `pg_aggregate` is an extension of an entry in `pg_proc`. The `pg_proc` entry carries the aggregate's name, input and output data types, and other information that is similar to ordinary functions. + +<a id="topic1__fu141982"></a> +<span class="tablecap">Table 1. pg\_catalog.pg\_aggregate</span> + +| column | type | references | description | +|------------------|---------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `aggfnoid` | regproc | pg\_proc.oid | Aggregate function OID | +| `aggtransfn` | regproc | pg\_proc.oid | Transition function OID | +| `aggprelimfn` | regproc |  | Preliminary function OID (zero if none) | +| `aggfinalfn` | regproc | pg\_proc.oid | Final function OID (zero if none) | +| `agginitval` | text |  | The initial value of the transition state. This is a text field containing the initial value in its external string representation. If this field is NULL, the transition state value starts out NULL | +| `agginvtransfn ` | regproc | pg\_proc.oid | The OID in pg\_proc of the inverse function of *aggtransfn* | +| `agginvprelimfn` | regproc | pg\_proc.oid | The OID in pg\_proc of the inverse function of aggprelimfn | +| `aggordered` | boolean |  | If `true`, the aggregate is defined as `ORDERED`. | +| `aggsortop` | oid | pg\_operator.oid | Associated sort operator OID (zero if none) | +| `aggtranstype` | oid | pg\_type.oid | Data type of the aggregate function's internal transition (state) data | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/pg_am.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/pg_am.html.md.erb b/markdown/reference/catalog/pg_am.html.md.erb new file mode 100644 index 0000000..96ba56b --- /dev/null +++ b/markdown/reference/catalog/pg_am.html.md.erb @@ -0,0 +1,38 @@ +--- +title: pg_am +--- + +The `pg_am` table stores information about index access methods. There is one row for each index access method supported by the system. + +<a id="topic1__fv141982"></a> +<span class="tablecap">Table 1. pg\_catalog.pg\_am</span> + +| column | type | references | description | +|-------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------| +| `amname` | name |  | Name of the access method | +| `amstrategies` | smallint |  | Number of operator strategies for this access method | +| `amsupport` | smallint |  | Number of support routines for this access method | +| `amorderstrategy` | smallint |  | Zero if the index offers no sort order, otherwise the strategy number of the strategy operator that describes the sort order | +| `amcanunique` | boolean |  | Does the access method support unique indexes? | +| `amcanmulticol` | boolean |  | Does the access method support multicolumn indexes? | +| `amoptionalkey` | boolean |  | Does the access method support a scan without any constraint for the first index column? | +| `amindexnulls` | boolean |  | Does the access method support null index entries? | +| `amstorage` | boolean |  | Can index storage data type differ from column data type? | +| `amclusterable` | boolean |  | Can an index of this type be clustered on? | +| `aminsert` | regproc | pg\_proc.oid | "Insert this tuple" function | +| `ambeginscan` | regproc | pg\_proc.oid | "Start new scan" function | +| `amgettuple` | regproc | pg\_proc.oid | "Next valid tuple" function | +| `amgetmulti` | regproc | pg\_proc.oid | "Fetch multiple tuples" function | +| `amrescan` | regproc | pg\_proc.oid | "Restart this scan" function | +| `amendscan` | regproc | pg\_proc.oid | "End this scan" function | +| `ammarkpos` | regproc | pg\_proc.oid | "Mark current scan position" function | +| `amrestrpos` | regproc | pg\_proc.oid | "Restore marked scan position" function | +| `ambuild` | regproc | pg\_proc.oid | "Build new index" function | +| `ambulkdelete` | regproc | pg\_proc.oid | Bulk-delete function | +| `amvacuumcleanup` | regproc | pg\_proc.oid | Post-`VACUUM` cleanup function | +| `amcostestimate` | regproc | pg\_proc.oid | Function to estimate cost of an index scan | +| `amoptions` | regproc | pg\_proc.oid | Function to parse and validate reloptions for an index | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/pg_amop.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/pg_amop.html.md.erb b/markdown/reference/catalog/pg_amop.html.md.erb new file mode 100644 index 0000000..c07bcd1 --- /dev/null +++ b/markdown/reference/catalog/pg_amop.html.md.erb @@ -0,0 +1,20 @@ +--- +title: pg_amop +--- + +The `pg_amop` table stores information about operators associated with index access method operator classes. There is one row for each operator that is a member of an operator class. + +<a id="topic1__fw143542"></a> +<span class="tablecap">Table 1. pg\_catalog.pg\_amop</span> + +| column | type | references | description | +|----------------|----------|------------------|----------------------------------------------------------------------------| +| `amopclaid` | oid | pg\_opclass.oid | The index operator class this entry is for | +| `amopsubtype` | oid | pg\_type.oid | Subtype to distinguish multiple entries for one strategy; zero for default | +| `amopstrategy` | smallint |  | Operator strategy number | +| `amopreqcheck` | boolean |  | Index hit must be rechecked | +| `amopopr` | oid | pg\_operator.oid | OID of the operator | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/pg_amproc.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/pg_amproc.html.md.erb b/markdown/reference/catalog/pg_amproc.html.md.erb new file mode 100644 index 0000000..7668bac --- /dev/null +++ b/markdown/reference/catalog/pg_amproc.html.md.erb @@ -0,0 +1,19 @@ +--- +title: pg_amproc +--- + +The `pg_amproc` table stores information about support procedures associated with index access method operator classes. There is one row for each support procedure belonging to an operator class. + +<a id="topic1__fx143898"></a> +<span class="tablecap">Table 1. pg\_catalog.pg\_amproc</span> + +| column | type | references | description | +|-----------------|---------|-----------------|--------------------------------------------| +| `amopclaid` | oid | pg\_opclass.oid | The index operator class this entry is for | +| `amprocsubtype` | oid | pg\_type.oid | Subtype, if cross-type routine, else zero | +| `amprocnum` | int2 |  | Support procedure number | +| `amproc` | regproc | pg\_proc.oid | OID of the procedure | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/pg_appendonly.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/pg_appendonly.html.md.erb b/markdown/reference/catalog/pg_appendonly.html.md.erb new file mode 100644 index 0000000..b0a56d6 --- /dev/null +++ b/markdown/reference/catalog/pg_appendonly.html.md.erb @@ -0,0 +1,29 @@ +--- +title: pg_appendonly +--- + +The `pg_appendonly` table contains information about the storage options and other characteristics of append-only tables. + +<a id="topic1__fy138428"></a> +<span class="tablecap">Table 1. pg\_catalog.pg\_appendonly</span> + +| column | type | references | description | +|-----------------|----------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| `relid` | oid |  | The table object identifier (OID) of the compressed table. | +| `compresslevel` | smallint |  | The compression level, with increasing compression ratio. If the `gzip` or `zlib` compression type is specified, valid values are 1-9. | +| `majorversion` | smallint |  | The major version number of the `pg_appendonly` table. | +| `minorversion` | smallint |  | The minor version number of the `pg_appendonly` table. | +| `checksum` | boolean |  | A checksum value that is stored to compare the state of a block of data at compression time and at scan time to ensure data integrity. | +| `compresstype` | text |  | Type of compression used on append-only and parquet tables. `zlib`, `snappy`, and `gzip` compression types are supported. | +| `columnstore` | boolean |  | `0` for row-oriented storage. | +| `segrelid` | oid |  | Table on-disk segment file id. | +| `segidxid` | oid |  | Index on-disk segment file id. | +| `blkdirrelid` | oid |  | Block used for on-disk column-oriented table file. | +| `blkdiridxid` | oid |  | Block used for on-disk column-oriented index file. | +| `version` | integer |  | Version of MemTuples and block layout for this table. | +| `pagesize` | integer |  | The max page size of this relation. Only valid for Parquet tables; otherwise, the value is 0. | +| `splitsize` | integer |  | Size of a split. Default value is 64M, which is controlled by server configuration parameter `appendonly_split_write_size_mb`. | + + + + http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/de1e2e07/markdown/reference/catalog/pg_attrdef.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/reference/catalog/pg_attrdef.html.md.erb b/markdown/reference/catalog/pg_attrdef.html.md.erb new file mode 100644 index 0000000..f4af77d --- /dev/null +++ b/markdown/reference/catalog/pg_attrdef.html.md.erb @@ -0,0 +1,19 @@ +--- +title: pg_attrdef +--- + +The `pg_attrdef` table stores column default values. The main information about columns is stored in [pg\_attribute](pg_attribute.html#topic1). Only columns that explicitly specify a default value (when the table is created or the column is added) will have an entry here. + +<a id="topic1__fz143898"></a> +<span class="tablecap">Table 1. pg\_catalog.pg\_attrdef</span> + +| column | type | references | description | +|-----------|----------|----------------------|-------------------------------------------------------------------------------------------------------| +| `adrelid` | oid | pg\_class.oid | The table this column belongs to | +| `adnum` | smallint | pg\_attribute.attnum | The number of the column | +| `adbin ` | text |  | The internal representation of the column default value | +| `adsrc` | text |  | A human-readable representation of the default value. This field is historical, and is best not used. | + + + +
