Repository: incubator-hawq-docs Updated Branches: refs/heads/develop c63a7eb3f -> 42235b15f
HAWQ-1180: ALTER ROLE set statement should be removed from documentation (janebeckman via yozie) Closes https://github.com/apache/incubator-hawq-docs/issues/68 Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/42235b15 Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/42235b15 Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/42235b15 Branch: refs/heads/develop Commit: 42235b15fe737abadd43f157d18d2322f0303a46 Parents: c63a7eb Author: David Yozie <[email protected]> Authored: Wed Dec 7 16:45:20 2016 -0800 Committer: David Yozie <[email protected]> Committed: Wed Dec 7 16:45:20 2016 -0800 ---------------------------------------------------------------------- admin/monitor.html.md.erb | 3 ++- clientaccess/roles_privs.html.md.erb | 6 ------ ddl/ddl-schema.html.md.erb | 9 +-------- reference/sql/ALTER-ROLE.html.md.erb | 8 ++------ reference/toolkit/hawq_toolkit.html.md.erb | 2 +- 5 files changed, 6 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/42235b15/admin/monitor.html.md.erb ---------------------------------------------------------------------- diff --git a/admin/monitor.html.md.erb b/admin/monitor.html.md.erb index 8395b99..81f6a04 100644 --- a/admin/monitor.html.md.erb +++ b/admin/monitor.html.md.erb @@ -181,7 +181,8 @@ $ hawq ssh -f seg_host_log_file Use HAWQ's administrative schema *hawq\_toolkit* to query the system catalogs, log files, and operating environment for system status information. The `hawq_toolkit` schema contains several views you can access using SQL commands. The *hawq\_toolkit* schema is accessible to all database users. Some objects require superuser permissions. Use a command similar to the following to add the *hawq\_toolkit* schema to your schema search path: ```sql -=> ALTER ROLE myrole SET search_path TO myschema,hawq_toolkit; +=>SET ROLE 'gpadmin' ; +=>SET search_path TO myschema, hawq_toolkit ; ``` ## <a id="topic_jx2_rqg_kp"></a>HAWQ Error Codes http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/42235b15/clientaccess/roles_privs.html.md.erb ---------------------------------------------------------------------- diff --git a/clientaccess/roles_privs.html.md.erb b/clientaccess/roles_privs.html.md.erb index 66f56d7..4bdf3ee 100644 --- a/clientaccess/roles_privs.html.md.erb +++ b/clientaccess/roles_privs.html.md.erb @@ -61,12 +61,6 @@ You can set these attributes when you create the role, or later using the `ALTER =# ALTER ROLE jsmith DENY DAY 'Sunday'; ``` -A role can also have role-specific defaults for many of the server configuration settings. For example, to set the default schema search path for a role: - -``` sql -=# ALTER ROLE admin SET search_path TO myschema, public; -``` - ## <a id="topic5"></a>Role Membership It is frequently convenient to group users together to ease management of object privileges: that way, privileges can be granted to, or revoked from, a group as a whole. In HAWQ this is done by creating a role that represents the group, and then granting membership in the group role to individual user roles. http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/42235b15/ddl/ddl-schema.html.md.erb ---------------------------------------------------------------------- diff --git a/ddl/ddl-schema.html.md.erb b/ddl/ddl-schema.html.md.erb index 1ccfbf0..7c361ba 100644 --- a/ddl/ddl-schema.html.md.erb +++ b/ddl/ddl-schema.html.md.erb @@ -49,13 +49,6 @@ The `search_path` configuration parameter sets the schema search order. The `ALT public, pg_catalog; ``` -You can also set `search_path` for a particular role \(user\) using the `ALTER ROLE` command. For example: - -``` sql -=> ALTER ROLE sally SET search_path TO myschema, public, -pg_catalog; -``` - ### <a id="topic22"></a>Viewing the Current Schema Use the `current_schema()` function to view the current schema. For example: @@ -92,4 +85,4 @@ The following system-level schemas exist in every database: - `information_schema` consists of a standardized set of views that contain information about the objects in the database. These views get system information from the system catalog tables in a standardized way. - `pg_toast` stores large objects such as records that exceed the page size. This schema is used internally by the HAWQ system. - `pg_bitmapindex` stores bitmap index objects such as lists of values. This schema is used internally by the HAWQ system. -- `gp_toolkit` is an administrative schema that contains external tables, views, and functions that you can access with SQL commands. All database users can access `gp_toolkit` to view and query the system log files and other system metrics. +- `hawq_toolkit` is an administrative schema that contains external tables, views, and functions that you can access with SQL commands. All database users can access `hawq_toolkit` to view and query the system log files and other system metrics. http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/42235b15/reference/sql/ALTER-ROLE.html.md.erb ---------------------------------------------------------------------- diff --git a/reference/sql/ALTER-ROLE.html.md.erb b/reference/sql/ALTER-ROLE.html.md.erb index 687e776..ccc2c28 100644 --- a/reference/sql/ALTER-ROLE.html.md.erb +++ b/reference/sql/ALTER-ROLE.html.md.erb @@ -9,8 +9,6 @@ Changes a database role (user or group). ```pre ALTER ROLE <name> RENAME TO <newname> -ALTER ROLE <name> RESET <config_parameter> - ALTER ROLE <name> RESOURCE QUEUE {<queue_name> | NONE} ALTER ROLE <name> [ [WITH] <option> [ ... ] ] @@ -43,10 +41,11 @@ where \<option\> can be: `ALTER ROLE` changes the attributes of a HAWQ role. There are several variants of this command: - **RENAME** â Changes the name of the role. Database superusers can rename any role. Roles having `CREATEROLE` privilege can rename non-superuser roles. The current session user cannot be renamed (connect as a different user to rename a role). Because MD5-encrypted passwords use the role name as cryptographic salt, renaming a role clears its password if the password is MD5-encrypted. -- **SET | RESET** â changes a roleâs session default for a specified configuration parameter. Whenever the role subsequently starts a new session, the specified value becomes the session default, overriding whatever setting is present in server configuration file (`hawq-site.xml`). For a role without LOGIN privilege, session defaults have no effect. Ordinary roles can change their own session defaults. Superusers can change anyoneâs session defaults. Roles having `CREATEROLE` privilege can change defaults for non-superuser roles. See "Server Configuration Parameters" Â for more information on all user-settable configuration parameters. - **RESOURCE QUEUE** â Assigns the role to a workload management resource queue. The role would then be subject to the limits assigned to the resource queue when issuing queries. Specify `NONE` to assign the role to the default resource queue. A role can only belong to one resource queue. For a role without `LOGIN` privilege, resource queues have no effect. See [CREATE RESOURCE QUEUE](CREATE-RESOURCE-QUEUE.html#topic1) for more information. - **WITH** \<option\> â Changes many of the role attributes that can be specified in [CREATE ROLE](CREATE-ROLE.html). Attributes not mentioned in the command retain their previous settings. Database superusers can change any of these settings for any role. Roles having `CREATEROLE` privilege can change any of these settings, but only for non-superuser roles. Ordinary roles can only change their own password. +**Note:** SET and RESET commands are currently not supported in connection with ALTER ROLE and will result in an error. See [SET](SET.html) and [About Server Configuration Parameters](../guc/guc_config.html#topic1) for information about user-settable configuration parameters. + ## <a id="alterrole__section4"></a>Parameters <dt> \<name\> </dt> @@ -55,9 +54,6 @@ where \<option\> can be: <dt> \<newname\> </dt> <dd>The new name of the role.</dd> -<dt> \<config\_parameter\>=\<value\> </dt> -<dd>Set this role's session default for the specified configuration parameter to the given value. If value is `DEFAULT` or if `RESET` is used, the role-specific variable setting is removed, so the role will inherit the system-wide default setting in new sessions. Use `RESET ALL` to clear all role-specific settings. See [SET](SET.html) and [About Server Configuration Parameters](../guc/guc_config.html#topic1) for information about user-settable configuration parameters.</dd> - <dt> \<queue\_name\> </dt> <dd>The name of the resource queue to which the user-level role is to be assigned. Only roles with `LOGIN` privilege can be assigned to a resource queue. To unassign a role from a resource queue and put it in the default resource queue, specify `NONE`. A role can only belong to one resource queue.</dd> http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/42235b15/reference/toolkit/hawq_toolkit.html.md.erb ---------------------------------------------------------------------- diff --git a/reference/toolkit/hawq_toolkit.html.md.erb b/reference/toolkit/hawq_toolkit.html.md.erb index 45a8a56..ac5db66 100644 --- a/reference/toolkit/hawq_toolkit.html.md.erb +++ b/reference/toolkit/hawq_toolkit.html.md.erb @@ -103,7 +103,7 @@ The table and index sizing views list the relation by object ID (not by name). T ``` pre SELECT relname as name, sotdsize as size, sotdtoastsize as toast, sotdadditionalsize as other -FROM gp_size_of_table_disk as sotd, pg_class +FROM hawq_size_of_table_disk as sotd, pg_class WHERE sotd.sotdoid=pg_class.oid ORDER BY relname; ```
