PostgreSQL Source Code  git master
tsmapi.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * tsmapi.h
4  * API for tablesample methods
5  *
6  * Copyright (c) 2015-2019, PostgreSQL Global Development Group
7  *
8  * src/include/access/tsmapi.h
9  *
10  *-------------------------------------------------------------------------
11  */
12 #ifndef TSMAPI_H
13 #define TSMAPI_H
14 
15 #include "nodes/execnodes.h"
16 #include "nodes/pathnodes.h"
17 
18 
19 /*
20  * Callback function signatures --- see tablesample-method.sgml for more info.
21  */
22 
24  RelOptInfo *baserel,
25  List *paramexprs,
26  BlockNumber *pages,
27  double *tuples);
28 
30  int eflags);
31 
33  Datum *params,
34  int nparams,
35  uint32 seed);
36 
38  BlockNumber nblocks);
39 
41  BlockNumber blockno,
42  OffsetNumber maxoffset);
43 
44 typedef void (*EndSampleScan_function) (SampleScanState *node);
45 
46 /*
47  * TsmRoutine is the struct returned by a tablesample method's handler
48  * function. It provides pointers to the callback functions needed by the
49  * planner and executor, as well as additional information about the method.
50  *
51  * More function pointers are likely to be added in the future.
52  * Therefore it's recommended that the handler initialize the struct with
53  * makeNode(TsmRoutine) so that all fields are set to NULL. This will
54  * ensure that no fields are accidentally left undefined.
55  */
56 typedef struct TsmRoutine
57 {
59 
60  /* List of datatype OIDs for the arguments of the TABLESAMPLE clause */
62 
63  /* Can method produce repeatable samples across, or even within, queries? */
66 
67  /* Functions for planning a SampleScan on a physical table */
69 
70  /* Functions for executing a SampleScan on a physical table */
76 } TsmRoutine;
77 
78 
79 /* Functions in access/tablesample/tablesample.c */
80 extern TsmRoutine *GetTsmRoutine(Oid tsmhandler);
81 
82 #endif /* TSMAPI_H */
InitSampleScan_function InitSampleScan
Definition: tsmapi.h:71
bool repeatable_across_queries
Definition: tsmapi.h:64
void(* EndSampleScan_function)(SampleScanState *node)
Definition: tsmapi.h:44
OffsetNumber(* NextSampleTuple_function)(SampleScanState *node, BlockNumber blockno, OffsetNumber maxoffset)
Definition: tsmapi.h:40
struct TsmRoutine TsmRoutine
uint32 BlockNumber
Definition: block.h:31
unsigned int Oid
Definition: postgres_ext.h:31
NodeTag
Definition: nodes.h:26
BlockNumber(* NextSampleBlock_function)(SampleScanState *node, BlockNumber nblocks)
Definition: tsmapi.h:37
void(* InitSampleScan_function)(SampleScanState *node, int eflags)
Definition: tsmapi.h:29
uint16 OffsetNumber
Definition: off.h:24
NextSampleTuple_function NextSampleTuple
Definition: tsmapi.h:74
unsigned int uint32
Definition: c.h:358
NextSampleBlock_function NextSampleBlock
Definition: tsmapi.h:73
SampleScanGetSampleSize_function SampleScanGetSampleSize
Definition: tsmapi.h:68
uintptr_t Datum
Definition: postgres.h:367
void(* BeginSampleScan_function)(SampleScanState *node, Datum *params, int nparams, uint32 seed)
Definition: tsmapi.h:32
BeginSampleScan_function BeginSampleScan
Definition: tsmapi.h:72
bool repeatable_across_scans
Definition: tsmapi.h:65
NodeTag type
Definition: tsmapi.h:58
List * parameterTypes
Definition: tsmapi.h:61
void(* SampleScanGetSampleSize_function)(PlannerInfo *root, RelOptInfo *baserel, List *paramexprs, BlockNumber *pages, double *tuples)
Definition: tsmapi.h:23
EndSampleScan_function EndSampleScan
Definition: tsmapi.h:75
Definition: pg_list.h:50
TsmRoutine * GetTsmRoutine(Oid tsmhandler)
Definition: tablesample.c:27