external
/
citus
mirror of https://github.com/citusdata/citus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add VACUUM/ANALYZE function comments

pull/1013/head
Jason Petersen 2016-12-13 16:22:06 -07:00
parent 1e1b2b8d52
commit 06e21fcebd
No known key found for this signature in database
GPG Key ID: 9F1D3510D110ABA9
1 changed files with 29 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/backend/distributed/executor/multi_utility.c
View File

@ -896,7 +896,16 @@ ProcessAlterObjectSchemaStmt(AlterObjectSchemaStmt *alterObjectSchemaStmt,
} }
/* TODO: Write function comments */ /*
* ProcessVacuumStmt processes vacuum statements that may need propagation to
* distributed tables. If a VACUUM or ANALYZE command references a distributed
* table, it is propagated to all involved nodes; otherwise, this function will
* immediately exit after some error checking.
*
* Unlike other Process functions within this file, this function does not
* return a modified parse node, as it is expected that the local VACUUM or
* ANALYZE has already been processed.
*/
static void static void
ProcessVacuumStmt(VacuumStmt *vacuumStmt, const char *vacuumCommand) ProcessVacuumStmt(VacuumStmt *vacuumStmt, const char *vacuumCommand)
{ {
@ -923,6 +932,15 @@ ProcessVacuumStmt(VacuumStmt *vacuumStmt, const char *vacuumCommand)
} }
/*
* IsSupportedDistributedVacuumStmt returns whether distributed execution of a
* given VacuumStmt is supported. The provided relationId (if valid) represents
* the table targeted by the provided statement.
*
* Returns true if the statement requires distributed execution and returns
* false otherwise; however, this function will raise errors if the provided
* statement needs distributed execution but contains unsupported options.
*/
static bool static bool
IsSupportedDistributedVacuumStmt(Oid relationId, VacuumStmt *vacuumStmt) IsSupportedDistributedVacuumStmt(Oid relationId, VacuumStmt *vacuumStmt)
{ {
@ -970,7 +988,10 @@ IsSupportedDistributedVacuumStmt(Oid relationId, VacuumStmt *vacuumStmt)
} }
/* TODO: Write function comments */ /*
* VacuumTaskList returns a list of tasks to be executed as part of processing
* a VacuumStmt which targets a distributed relation.
*/
static List * static List *
VacuumTaskList(Oid relationId, VacuumStmt *vacuumStmt) VacuumTaskList(Oid relationId, VacuumStmt *vacuumStmt)
{ {
@ -1017,7 +1038,12 @@ VacuumTaskList(Oid relationId, VacuumStmt *vacuumStmt)
} }
/* TODO: Write function comments */ /*
* DeparseVacuumStmtPrefix returns a StringInfo appropriate for use as a prefix
* during distributed execution of a VACUUM or ANALYZE statement. Callers may
* reuse this prefix within a loop to generate shard-specific VACUUM or ANALYZE
* statements.
*/
static StringInfo static StringInfo
DeparseVacuumStmtPrefix(VacuumStmt *vacuumStmt) DeparseVacuumStmtPrefix(VacuumStmt *vacuumStmt)
{ {