From: Marko Kreen <markokr@gmail.com>
Date: Tue, 13 Sep 2011 13:17:11 +0000 (+0300)
Subject: doc: remove overview.txt, its unmaintained
X-Git-Tag: plproxy_2_3_rc1~1
X-Git-Url: http://git.postgresql.org/gitweb/static/gitweb.js?a=commitdiff_plain;h=36a81e45970d44fa103807df22bb56ed5116040c;p=plproxy.git

doc: remove overview.txt, its unmaintained

it was copy of old wiki page
---

diff --git a/Makefile b/Makefile
index bc1af1f..03aa782 100644
--- a/Makefile
+++ b/Makefile
@@ -29,7 +29,7 @@ DIST_DIRS = src sql expected config doc debian
 DIST_FILES = Makefile src/plproxy.h src/rowstamp.h src/scanner.l src/parser.y \
 			 $(foreach t,$(REGRESS),sql/$(t).sql expected/$(t).out) \
 			 config/simple.config.sql src/poll_compat.h \
-			 doc/Makefile doc/config.txt doc/overview.txt doc/faq.txt \
+			 doc/Makefile doc/config.txt doc/faq.txt \
 			 doc/syntax.txt doc/todo.txt doc/tutorial.txt \
 			 AUTHORS COPYRIGHT README plproxy_lang.sql plproxy_fdw.sql NEWS \
 			 debian/packages.in debian/changelog
diff --git a/doc/overview.txt b/doc/overview.txt
deleted file mode 100644
index e967c5e..0000000
--- a/doc/overview.txt
+++ /dev/null
@@ -1,90 +0,0 @@
-#pragma section-numbers 2
-
-= PL/Proxy =
-
-[[TableOfContents]]
-
-== Overview ==
-
-PL/Proxy is a proxy language used for remote database procedure calls
-and data partitioning between databases based on hashing field values.
-
-Main idea is that proxy function will be created with same
-signature as remote function to be called, so only destination
-info needs to be specified inside proxy function body.
-
-Downloads: http://pgfoundry.org/projects/plproxy
-
-== Documentation ==
-
- * [http://plproxy.projects.postgresql.org/doc/tutorial.html	Tutorial ]
- * [http://plproxy.projects.postgresql.org/doc/syntax.html	Language reference ]
- * [http://plproxy.projects.postgresql.org/doc/config.html	Cluster configuration ]
- * [http://plproxy.projects.postgresql.org/doc/todo.html	TODO list ]
-
-== Features ==
-
- * PL/Proxy functions detect remote functions to be called from their own signature.
- * Function can be run on one, some or all members of the cluster.
- * If query is executed on several partitions, it will happen in parallel.
- * Queries are run in auto-commit mode on the remote server.
- * Query parameters are sent separately from query body, thus avoiding
- quoting/unquoting overhead on both sides.
- * If proxy and partition backend versions match,
- PL/Proxy tries to use binary I/O if possible.
-
-== Restrictions ==
-
- * PL/Proxy launches connections into each part from each backend, so in
- heavy-duty environment is necessary to put pooler between PL/Proxy
- and partitions.  We have specially for that developed ../PgBouncer
- which is a pooler that can do statement-based pooling - release server
- after each SQL statement.
-
-== Language examples ==
-
-=== Simple remote function call ===
-
-Connect to `dbname=users` and run following SQL there: `SELECT * from get_user_email($1);`
-
-{{{
-CREATE FUNCTION get_user_email(username text)
-RETURNS text AS $$
-
-    CONNECT 'dbname=users';
-
-$$ LANGUAGE plproxy;
-}}}
-
-=== Partitioned remote call ===
-
-Users are spread over several databases, partition number is acquired
-by taking hashtext(username).  This needs also configuring the cluster,
-described in documentation.  After this is done, actual proxy function
-looks following:
-
-{{{
-CREATE FUNCTION get_user_email(username text)
-RETURNS text AS $$
-
-    CLUSTER 'userdb';
-    RUN ON hashtext(username);
-
-$$ LANGUAGE plproxy;
-}}}
-
-=== Run user-specified SELECT statement remotely ===
-
-By default, PL/Proxy generates query based on its own signature.
-But this can be overrided by giving explicit `SELECT` statement to run.
-
-{{{
-CREATE FUNCTION get_user_location(text)
-RETURNS SETOF text AS $$
-
-    CLUSTER 'userdb';
-    RUN ON hashtext($1);
-    SELECT email FROM users WHERE user = $1;
-
-$$ LANGUAGE plproxy;
-}}}