From: Tom Lane Date: Wed, 17 Mar 2010 15:55:55 +0000 (+0000) Subject: Fix incorrect example in CREATE INDEX reference page, per Josh Kupershmidt. X-Git-Tag: REL8_4_4~44 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3c1e84ad00615a39a7fbcaa9ee75e7711eb82cd4;p=postgresql Fix incorrect example in CREATE INDEX reference page, per Josh Kupershmidt. Also fix and uncomment an old example of creating a GIST index, and make a couple of other minor editorial adjustments. --- diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml index 49352accae..5104a656e9 100644 --- a/doc/src/sgml/ref/create_index.sgml +++ b/doc/src/sgml/ref/create_index.sgml @@ -1,5 +1,5 @@ @@ -264,10 +264,10 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] nameIndex Storage Parameters - The WITH clause can specify storage parameters - for indexes. Each index method can have its own set of allowed storage - parameters. The B-tree, hash and - GiST built-in index methods all accept a single parameter: + The optional WITH clause specifies storage + parameters for the index. Each index method has its own set of allowed + storage parameters. The B-tree, hash and GiST index methods all accept a + single parameter: @@ -279,10 +279,11 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] namename - GIN indexes accept a different parameter: + GIN indexes accept a different parameter: @@ -371,7 +372,7 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] nameinvalid index. This index will be ignored for querying purposes because it might be incomplete; however it will still consume update overhead. The psql - \d command will mark such an index as INVALID: + \d command will report such an index as INVALID: postgres=# \d tab @@ -455,8 +456,8 @@ Indexes: For index methods that support ordered scans (currently, only B-tree), the optional clauses ASC, DESC, NULLS - FIRST, and/or NULLS LAST can be specified to reverse - the normal sort direction of the index. Since an ordered index can be + FIRST, and/or NULLS LAST can be specified to modify + the sort ordering of the index. Since an ordered index can be scanned either forward or backward, it is not normally useful to create a single-column DESC index — that sort ordering is already available with a regular index. The value of these options is that @@ -535,7 +536,7 @@ CREATE UNIQUE INDEX title_idx ON films (title) WITH (fillfactor = 70); To create a GIN index with fast updates disabled: -CREATE INDEX gin_idx ON documents_table (locations) WITH (fastupdate = off); +CREATE INDEX gin_idx ON documents_table USING gin (locations) WITH (fastupdate = off); @@ -548,22 +549,17 @@ CREATE INDEX code_idx ON films(code) TABLESPACE indexspace; - To create an index without locking out writes to the table: