From a9e2d199189c885acca1d97a04a0fd36a675f3c6 Mon Sep 17 00:00:00 2001 From: Javier Goizueta Date: Tue, 12 Jan 2016 16:20:11 +0100 Subject: [PATCH] Document CDB_DropOverviews --- doc/CDB_Overviews.md | 20 ++++++++++++++++++-- scripts-available/CDB_Overviews.sql | 4 ++++ 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/doc/CDB_Overviews.md b/doc/CDB_Overviews.md index 019a856..2f2a006 100644 --- a/doc/CDB_Overviews.md +++ b/doc/CDB_Overviews.md @@ -11,8 +11,9 @@ The statement timeout may need to be adjusted before using this function, as overview creation for large tables is a time-consuming operation. The `CDB_Overviews` function can be used determine what overview tables -exist for a given dataset table and which zoom levels correspond tt +exist for a given dataset table and which zoom levels correspond to it. +The `CDB_DropOverviews` remove a dataset's existing overviews. ### CDB_CreateOverviews @@ -49,7 +50,8 @@ CDB_CreateOverviews(table_name, ref_z_strategy, reduction_strategy) ### CDB_Overviews -Obtain overview metadata for a given table (existing overviews) +Obtain overview metadata for a given table (existing overviews). +The returned relation will be empty if the table has no overviews. ```sql SELECT CDB_Overviews('table_name'); @@ -61,3 +63,17 @@ SELECT CDB_Overviews('table_name'); CDB_Overviews(table_name) * **table_name** regclass, table to obtain existing overviews for + +### CDB_DropOverviews + +Remove the overviews of a table, if present. + +```sql +SELECT CDB_DropOverviews('table_name'); +``` + +#### Arguments + +CDB_Overviews(table_name) + +* **table_name** regclass, table for which to drop existing overviews. diff --git a/scripts-available/CDB_Overviews.sql b/scripts-available/CDB_Overviews.sql index e25875b..2776f53 100644 --- a/scripts-available/CDB_Overviews.sql +++ b/scripts-available/CDB_Overviews.sql @@ -1,3 +1,7 @@ +-- Remove a dataset's existing overview tables. +-- Scope: public +-- Parameters: +-- reloid: oid of the table. CREATE OR REPLACE FUNCTION CDB_DropOverviews(reloid REGCLASS) RETURNS void AS $$