pgsql: tableam: basic documentation.

Started by Andres Freundalmost 7 years ago4 messages

andres@anarazel.de

almost 7 years ago

tableam: basic documentation.

This adds documentation about the user oriented parts of table access
methods (i.e. the default_table_access_method GUC and the USING clause
for CREATE TABLE etc), adds a basic chapter about the table access
method interface, and adds a note to storage.sgml that it's contents
don't necessarily apply for non-builtin AMs.

Author: Haribabu Kommi and Andres Freund
Discussion: /messages/by-id/20180703070645.wchpu5muyto5n647@alap3.anarazel.de

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/b73c3a11963c8bb783993cfffabb09f558f86e37

Modified Files
--------------
doc/src/sgml/catalogs.sgml | 9 +-
doc/src/sgml/config.sgml | 17 ++++
doc/src/sgml/filelist.sgml | 1 +
doc/src/sgml/indexam.sgml | 12 ++-
doc/src/sgml/postgres.sgml | 1 +
doc/src/sgml/ref/create_access_method.sgml | 14 ++--
doc/src/sgml/ref/create_materialized_view.sgml | 16 ++++
doc/src/sgml/ref/create_table.sgml | 19 ++++-
doc/src/sgml/ref/create_table_as.sgml | 15 ++++
doc/src/sgml/ref/select_into.sgml | 10 +++
doc/src/sgml/storage.sgml | 17 +++-
doc/src/sgml/tableam.sgml | 110 +++++++++++++++++++++++++
src/include/access/tableam.h | 3 +
13 files changed, 228 insertions(+), 16 deletions(-)

Michael Paquier

michael@paquier.xyz

almost 7 years ago

In reply to: Andres Freund (#1)

Re: pgsql: tableam: basic documentation.

Hi Andres,

On Thu, Apr 04, 2019 at 12:42:06AM +0000, Andres Freund wrote:

tableam: basic documentation.

This adds documentation about the user oriented parts of table access
methods (i.e. the default_table_access_method GUC and the USING clause
for CREATE TABLE etc), adds a basic chapter about the table access
method interface, and adds a note to storage.sgml that it's contents
don't necessarily apply for non-builtin AMs.

Author: Haribabu Kommi and Andres Freund
Discussion: /messages/by-id/20180703070645.wchpu5muyto5n647@alap3.anarazel.de

+  Any developer of a new <literal>table access method</literal> can refer to
+  the existing <literal>heap</literal> implementation present in
+  <filename>src/backend/heap/heapam_handler.c</filename> for more details of
+  how it is implemented.

This path is incorrect, it should be that instead (missing "access"):
src/backend/access/heap/heapam_handler.c
--
Michael

Haribabu Kommi

kommi.haribabu@gmail.com

almost 7 years ago

In reply to: Michael Paquier (#2)

1 attachment(s)

Re: pgsql: tableam: basic documentation.

On Wed, Apr 10, 2019 at 12:56 PM Michael Paquier <michael@paquier.xyz>
wrote:

Hi Andres,

On Thu, Apr 04, 2019 at 12:42:06AM +0000, Andres Freund wrote:

tableam: basic documentation.

This adds documentation about the user oriented parts of table access
methods (i.e. the default_table_access_method GUC and the USING clause
for CREATE TABLE etc), adds a basic chapter about the table access
method interface, and adds a note to storage.sgml that it's contents
don't necessarily apply for non-builtin AMs.

Author: Haribabu Kommi and Andres Freund
Discussion:

/messages/by-id/20180703070645.wchpu5muyto5n647@alap3.anarazel.de
+  Any developer of a new <literal>table access method</literal> can refer
to
+  the existing <literal>heap</literal> implementation present in
+  <filename>src/backend/heap/heapam_handler.c</filename> for more details
of
+  how it is implemented.
This path is incorrect, it should be that instead (missing "access"):
src/backend/access/heap/heapam_handler.c

Thanks for the review, Yes I missed it when I added the path.
Patch attached.

Regards,
Haribabu Kommi
Fujitsu Australia

Attachments:

0001-tabeam-docs-file-path-correction.patchapplication/octet-stream; name=0001-tabeam-docs-file-path-correction.patchDownload

From 3cf0690d5e7da8184ffe82f475f1a085b5b5c48e Mon Sep 17 00:00:00 2001
From: Hari Babu <kommi.haribabu@gmail.com>
Date: Wed, 10 Apr 2019 13:12:02 +1000
Subject: [PATCH] tabeam docs: file path correction

heapam_handler.c file path correction
---
 doc/src/sgml/tableam.sgml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/src/sgml/tableam.sgml b/doc/src/sgml/tableam.sgml
index 6c9f820aca..efd141d3f5 100644
--- a/doc/src/sgml/tableam.sgml
+++ b/doc/src/sgml/tableam.sgml
@@ -104,7 +104,7 @@
  <para>
   Any developer of a new <literal>table access method</literal> can refer to
   the existing <literal>heap</literal> implementation present in
-  <filename>src/backend/heap/heapam_handler.c</filename> for details of
+  <filename>src/backend/access/heap/heapam_handler.c</filename> for details of
   its implementation.
  </para>
 
-- 
2.20.1.windows.1

Andres Freund

andres@anarazel.de

over 6 years ago

In reply to: Michael Paquier (#2)

Re: pgsql: tableam: basic documentation.

Hi,

On 2019-04-10 11:55:31 +0900, Michael Paquier wrote:

Hi Andres,

On Thu, Apr 04, 2019 at 12:42:06AM +0000, Andres Freund wrote:

tableam: basic documentation.

This adds documentation about the user oriented parts of table access
methods (i.e. the default_table_access_method GUC and the USING clause
for CREATE TABLE etc), adds a basic chapter about the table access
method interface, and adds a note to storage.sgml that it's contents
don't necessarily apply for non-builtin AMs.

Author: Haribabu Kommi and Andres Freund
Discussion: /messages/by-id/20180703070645.wchpu5muyto5n647@alap3.anarazel.de
+  Any developer of a new <literal>table access method</literal> can refer to
+  the existing <literal>heap</literal> implementation present in
+  <filename>src/backend/heap/heapam_handler.c</filename> for more details of
+  how it is implemented.
This path is incorrect, it should be that instead (missing "access"):
src/backend/access/heap/heapam_handler.c

Thanks, fix pushed.

Greetings,

Andres Freund