pgadmin-org
/
pgadmin4
mirror of https://github.com/pgadmin-org/pgadmin4.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tidy up table formatting in the docs. Thanks to Susan Douglas for the tips!

pull/22/head
Dave Page 2019-03-21 11:38:34 +00:00
parent 61f11aa4fc
commit 3f22503ad2
5 changed files with 147 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/en_US/desktop_deployment.rst
View File

@ -76,15 +76,19 @@ and the registry on Windows (HKEY_CURRENT_USER\\Software\\pgadmin\\pgadmin4).
The configuration settings:
+--------------------------+--------------------+---------------------------------------------------------------+
| Key | Type | Purpose |
+==========================+====================+===============================================================+
| ApplicationPath | String | The directory containing pgAdmin4.py |
+--------------------------+--------------------+---------------------------------------------------------------+
| BrowserCommand | String | An alternate command to run instead of the default browser. |
+--------------------------+--------------------+---------------------------------------------------------------+
| ConnectionTimeout | Integer | The number of seconds to wait for application server startup. |
+--------------------------+--------------------+---------------------------------------------------------------+
| PythonPath | String | The Python module search path |
+--------------------------+--------------------+---------------------------------------------------------------+
.. table::
:class: longtable
:widths: 2 1 4
+--------------------------+--------------------+---------------------------------------------------------------+
| Key | Type | Purpose |
+==========================+====================+===============================================================+
| ApplicationPath | String | The directory containing pgAdmin4.py |
+--------------------------+--------------------+---------------------------------------------------------------+
| BrowserCommand | String | An alternate command to run instead of the default browser. |
+--------------------------+--------------------+---------------------------------------------------------------+
| ConnectionTimeout | Integer | The number of seconds to wait for application server startup. |
+--------------------------+--------------------+---------------------------------------------------------------+
| PythonPath | String | The Python module search path |
+--------------------------+--------------------+---------------------------------------------------------------+

7
docs/en_US/keyboard_shortcuts.rst
View File

@ -13,6 +13,7 @@ When using main browser window, the following keyboard shortcuts are available:
.. table::
:class: longtable
:widths: 2 3
+----------------------------+-------------------------------------------------------+
| Shortcut for all platforms | Function |
@ -53,6 +54,7 @@ Use the shortcuts below to navigate the tabsets on dialogs:
.. table::
:class: longtable
:widths: 2 3
+----------------------------+-------------------------------------------------------+
| Shortcut for all platforms | Function |
@ -69,6 +71,7 @@ When using the syntax-highlighting SQL editors, the following shortcuts are avai
.. table::
:class: longtable
:widths: 2 2 3
+--------------------------+------------------+-------------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@ -121,6 +124,7 @@ When using the Query Tool, the following shortcuts are available:
.. table::
:class: longtable
:widths: 2 2 3
+--------------------------+--------------------+-----------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@ -169,6 +173,7 @@ When using the Debugger, the following shortcuts are available:
.. table::
:class: longtable
:widths: 2 2 3
+--------------------------+--------------------+-----------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@ -196,6 +201,7 @@ for inner panel navigation:
.. table::
:class: longtable
:widths: 2 2 3
+--------------------------+---------------------------+------------------------------+
| Shortcut (Windows/Linux) | Shortcut (Mac) | Function |
@ -213,6 +219,7 @@ default access keys for supported browsers.
.. table::
:class: longtable
:widths: 2 1 1 1
+-------------------+------------+------------+------------+
| | Windows | Linux | Mac |

57
docs/en_US/query_tool_toolbar.rst
View File

@ -24,6 +24,7 @@ File Options
.. table::
:class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut |
@ -44,25 +45,26 @@ Editing Options
.. table::
:class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut |
+======================+===================================================================================================+================+
| *Find* | Use the *Find* menu to search, replace, or navigate the code displayed in the SQL Editor: | |
| | | |
| | * Select *Find* to provide a search target, and search the SQL Editor contents. | Cmd+F |
| | | |
| | * Select *Find next* to locate the next occurrence of the search target. | Cmd+G |
| | | |
| | * Select *Find previous* to move to the last occurrence of the search target. | Cmd+Shift+G |
| | | |
| | * Select *Pesistent find* to identify all occurrences of the search target within the editor. | |
| | | |
| | * Select *Replace* to locate and replace (with prompting) individual occurrences of the target. | Cmd+Shift+F |
| | | |
| | * Select *Replace all* to locate and replace all occurrences of the target within the editor. | |
| | | |
| | * Select *Jump* to navigate to the next occurrence of the search target. | Alt+G |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Find* to provide a search target, and search the SQL Editor contents. | Cmd+F |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Find next* to locate the next occurrence of the search target. | Cmd+G |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Find previous* to move to the last occurrence of the search target. | Cmd+Shift+G |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Pesistent find* to identify all occurrences of the search target within the editor. | |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Replace* to locate and replace (with prompting) individual occurrences of the target. | Cmd+Shift+F |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Replace all* to locate and replace all occurrences of the target within the editor. | |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Jump* to navigate to the next occurrence of the search target. | Alt+G |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Copy* | Click the *Copy* icon to copy the content that is currently highlighted in the Data Output panel. | Accesskey + C |
| | when in View/Edit data mode. | |
@ -73,19 +75,18 @@ Editing Options
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| *Edit* | Use options on the *Edit* menu to access text editing tools; the options operate on the text | |
| | displayed in the SQL Editor panel when in Query Tool mode: | |
| | | |
| | * Select *Indent Selection* to indent the currently selected text. | Tab |
| | | |
| | * Select *Unindent Selection* to remove indentation from the currently selected text. | Shift+Tab |
| | | |
| | * Select *Inline Comment Selection* to enclose any lines that contain the selection in | Cmd+/ |
| | SQL style comment notation. | |
| | | |
| | * Select *Inline Uncomment Selection* to remove SQL style comment notation from the | Cmd+. |
| | selected line. | |
| | | |
| | * Select *Block Comment* to enclose all lines that contain the selection in C style | Shift+Cmd+/ |
| | comment notation. This option acts as a toggle. | |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Indent Selection* to indent the currently selected text. | Tab |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Unindent Selection* to remove indentation from the currently selected text. | Shift+Tab |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Inline Comment Selection* to enclose any lines that contain the selection in SQL style | Cmd+/ |
| | comment notation. | |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Inline Uncomment Selection* to remove SQL style comment notation from the selected line. | Cmd+. |
| +---------------------------------------------------------------------------------------------------+----------------+
| | Select *Block Comment* to enclose all lines that contain the selection in C style comment | Shift+Cmd+/ |
| | notation. This option acts as a toggle. | |
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
View/Edit Data Resultset Control
@ -93,6 +94,7 @@ View/Edit Data Resultset Control
.. table::
:class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut |
@ -119,6 +121,7 @@ Query Execution
.. table::
:class: longtable
:widths: 1 4 1
+----------------------+---------------------------------------------------------------------------------------------------+----------------+
| Icon | Behavior | Shortcut |

110
docs/en_US/tabbed_browser.rst
View File

@ -102,59 +102,63 @@ that is selected. Click a column heading to sort the table by the data displayed
in the column; click again to reverse the sort order. The following table lists
some of the statistics that are available:
+----------------------------+------------------------------------------------------------------------------------------------------------+
| Panel | Description |
+============================+============================================================================================================+
| *PID* | The process ID associated with the row. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *User* | The name of the user that owns the object. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Database* | displays the database name. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Backends* | displays the number of current connections to the database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Backend start* | The start time of the backend process. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Committed* | displays the number of transactions committed to the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Rolled Back* | displays the number of transactions rolled back within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Blocks Read* | displays the number of blocks read from memory (in megabytes) within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Blocks Hit* | displays the number of blocks hit in the cache (in megabytes) within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Returned* | displays the number of tuples returned within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Fetched* | displays the number of tuples fetched within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Inserted* | displays the number of tuples inserted into the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Updated* | displays the number of tuples updated in the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Deleted* | displays the number of tuples deleted from the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Last statistics reset* | displays the time of the last statistics reset for the database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tablespace conflicts* | displays the number of queries canceled because of recovery conflict with dropped tablespaces in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Lock conflicts* | displays the number of queries canceled because of recovery conflict with locks in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Snapshot conflicts* | displays the number of queries canceled because of recovery conflict with old snapshots in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Bufferpin conflicts* | displays the number of queries canceled because of recovery conflict with pinned buffers in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Temporary files* | displays the total number of temporary files, including those used by the statistics collector. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Size of temporary files* | displays the size of the temporary files. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Deadlocks* | displays the number of queries canceled because of a recovery conflict with deadlocks in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Block read time* | displays the number of milliseconds required to read the blocks read. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Block write time* | displays the number of milliseconds required to write the blocks read. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Size* | displays the size (in megabytes) of the selected database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
.. table::
:class: longtable
:widths: 1 4
+----------------------------+------------------------------------------------------------------------------------------------------------+
| Panel | Description |
+============================+============================================================================================================+
| *PID* | The process ID associated with the row. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *User* | The name of the user that owns the object. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Database* | displays the database name. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Backends* | displays the number of current connections to the database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Backend start* | The start time of the backend process. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Committed* | displays the number of transactions committed to the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Xact Rolled Back* | displays the number of transactions rolled back within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Blocks Read* | displays the number of blocks read from memory (in megabytes) within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Blocks Hit* | displays the number of blocks hit in the cache (in megabytes) within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Returned* | displays the number of tuples returned within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Fetched* | displays the number of tuples fetched within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Inserted* | displays the number of tuples inserted into the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Updated* | displays the number of tuples updated in the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tuples Deleted* | displays the number of tuples deleted from the database within the last week. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Last statistics reset* | displays the time of the last statistics reset for the database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Tablespace conflicts* | displays the number of queries canceled because of recovery conflict with dropped tablespaces in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Lock conflicts* | displays the number of queries canceled because of recovery conflict with locks in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Snapshot conflicts* | displays the number of queries canceled because of recovery conflict with old snapshots in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Bufferpin conflicts* | displays the number of queries canceled because of recovery conflict with pinned buffers in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Temporary files* | displays the total number of temporary files, including those used by the statistics collector. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Size of temporary files* | displays the size of the temporary files. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Deadlocks* | displays the number of queries canceled because of a recovery conflict with deadlocks in database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Block read time* | displays the number of milliseconds required to read the blocks read. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Block write time* | displays the number of milliseconds required to write the blocks read. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
| *Size* | displays the size (in megabytes) of the selected database. |
+----------------------------+------------------------------------------------------------------------------------------------------------+
.. image:: images/main_dependencies.png
:alt: Dependencies panel

68
docs/en_US/table_dialog.rst
View File

@ -74,20 +74,24 @@ must satisfy for an *INSERT* or *UPDATE* operation to succeed. Select the
appropriate constraint type by selecting one of the following tabs on the
*Constraints* panel:
+----------------+---------------------------------------------------------------------------------------------------------------------+
| Tab Name | Constraint |
+================+=====================================================================================================================+
| *Primary Key* | Provides a unique identifier for each row in the table. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Foreign Key* | Maintains referential integrity between two tables. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Check* | Requires data satisfies an expression or condition before insertion or modification. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Unique* | Ensures that the data contained in a column, or a group of columns, is unique among all the rows in the table. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Exclude* | Guarantees that if any two rows are compared on the specified column or expression (using the specified operator), |
| | at least one of the operator comparisons will return false or null. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
.. table::
:class: longtable
:widths: 1 4
+----------------+---------------------------------------------------------------------------------------------------------------------+
| Tab Name | Constraint |
+================+=====================================================================================================================+
| *Primary Key* | Provides a unique identifier for each row in the table. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Foreign Key* | Maintains referential integrity between two tables. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Check* | Requires data satisfies an expression or condition before insertion or modification. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Unique* | Ensures that the data contained in a column, or a group of columns, is unique among all the rows in the table. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
| *Exclude* | Guarantees that if any two rows are compared on the specified column or expression (using the specified operator), |
| | at least one of the operator comparisons will return false or null. |
+----------------+---------------------------------------------------------------------------------------------------------------------+
To add a primary key for the table, select the *Primary Key* tab, and click the
*Add* icon (+). To define the primary key, click the *Edit* icon to the left of
@ -212,22 +216,26 @@ updated or deleted:
The supported actions are:
+-------------+------------------------------------------------------------------------------------------------------------+
| NO ACTION | Produce an error indicating that the deletion or update will create a foreign key constraint violation. |
| | If the constraint is deferred, this error will be produced at constraint check time if any referencing |
| | rows still exist. This is the default. |
+-------------+------------------------------------------------------------------------------------------------------------+
| RESTRICT | Throw an error indicating that the deletion or update would create a foreign key constraint violation. |
| | This is the same as NO ACTION except that the check is not deferrable. |
+-------------+------------------------------------------------------------------------------------------------------------+
| CASCADE | Delete any rows referencing the deleted row, or update the values of the referencing column(s) to the new |
| | values of the referenced columns, respectively. |
+-------------+------------------------------------------------------------------------------------------------------------+
| SET NULL | Set the referencing column(s) to null. |
+-------------+------------------------------------------------------------------------------------------------------------+
| SET DEFAULT | Set the referencing column(s) to their default values. There must be a row in the referenced table |
| | that matches the default values (if they are not null), or the operation will fail. |
+-------------+------------------------------------------------------------------------------------------------------------+
.. table::
:class: longtable
:widths: 1 4
+-------------+------------------------------------------------------------------------------------------------------------+
| NO ACTION | Produce an error indicating that the deletion or update will create a foreign key constraint violation. |
| | If the constraint is deferred, this error will be produced at constraint check time if any referencing |
| | rows still exist. This is the default. |
+-------------+------------------------------------------------------------------------------------------------------------+
| RESTRICT | Throw an error indicating that the deletion or update would create a foreign key constraint violation. |
| | This is the same as NO ACTION except that the check is not deferrable. |
+-------------+------------------------------------------------------------------------------------------------------------+
| CASCADE | Delete any rows referencing the deleted row, or update the values of the referencing column(s) to the new |
| | values of the referenced columns, respectively. |
+-------------+------------------------------------------------------------------------------------------------------------+
| SET NULL | Set the referencing column(s) to null. |
+-------------+------------------------------------------------------------------------------------------------------------+
| SET DEFAULT | Set the referencing column(s) to their default values. There must be a row in the referenced table |
| | that matches the default values (if they are not null), or the operation will fail. |
+-------------+------------------------------------------------------------------------------------------------------------+
.. image:: images/table_check.png
:alt: Table dialog check constraint