Skip to content

Commit

Permalink
Changes references from pg 9.5 to 9.6 (#194)
Browse files Browse the repository at this point in the history
* Change references from pg 9.5 to 9.6

* Also fix detected broken links in mobile menu
  • Loading branch information
begriffs committed Nov 10, 2016
1 parent 2f87ca9 commit 5d72f03
Show file tree
Hide file tree
Showing 22 changed files with 62 additions and 57 deletions.
7 changes: 4 additions & 3 deletions _themes/citus/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,10 @@
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
<ul>
<li><a href="/product/citus">Product</a></li>
<li><a href="/solutions/applications">Solutions</a></li>
<li><a href="/blog">Blog</a></li>
<li><a href="https://www.citusdata.com/product/citus">Product</a></li>
<li><a href="https://www.citusdata.com/solutions/applications">Solutions</a></li>
<li><a href="https://www.citusdata.com/blog">Blog</a></li>
<li><a href="#">Documentation</a></li>
</ul>
</nav>

Expand Down
2 changes: 1 addition & 1 deletion admin_guide/cluster_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ master node fails, the standby can be promoted to the primary automatically to
serve queries to your cluster. For details on setting this up, please refer to the `PostgreSQL wiki <https://wiki.postgresql.org/wiki/Streaming_Replication>`_.

2. Since the metadata tables are small, users can use EBS volumes, or `PostgreSQL
backup tools <http://www.postgresql.org/docs/9.5/static/backup.html>`_ to backup the metadata. Then, they can easily
backup tools <http://www.postgresql.org/docs/9.6/static/backup.html>`_ to backup the metadata. Then, they can easily
copy over that metadata to new nodes to resume operation.

3. Citus's metadata tables are simple and mostly contain text columns which
Expand Down
4 changes: 2 additions & 2 deletions cloud/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The logs will contain the following messages:

* Citus and PostgreSQL errors
* Slow queries that take longer than 30 seconds
* `Checkpoint <https://www.postgresql.org/docs/9.5/static/wal-configuration.html>`_ statistics
* `Checkpoint <https://www.postgresql.org/docs/9.6/static/wal-configuration.html>`_ statistics
* Temporary files that are written and bigger than 64 MB
* `Autovacuum <https://www.postgresql.org/docs/9.5/static/routine-vacuuming.html#AUTOVACUUM>`_ that takes more than 30 seconds
* `Autovacuum <https://www.postgresql.org/docs/9.6/static/routine-vacuuming.html#AUTOVACUUM>`_ that takes more than 30 seconds


Recent Logs
Expand Down
4 changes: 2 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@
# built documents.
#
# The short X.Y version.
version = '5.2'
version = '6.0'
# The full version, including alpha/beta/rc tags.
release = '5.2.1'
release = '6.0.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 2 additions & 2 deletions dist_tables/ddl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Creating Distributed Tables (DDL)

::

export PATH=/usr/lib/postgresql/9.5/:$PATH
export PATH=/usr/lib/postgresql/9.6/:$PATH

We use the github events dataset to illustrate the commands below. You can download that dataset by running:

Expand All @@ -20,7 +20,7 @@ We use the github events dataset to illustrate the commands below. You can downl
Creating And Distributing Tables
--------------------------------

To create a distributed table, you need to first define the table schema. To do so, you can define a table using the `CREATE TABLE <http://www.postgresql.org/docs/9.5/static/sql-createtable.html>`_ statement in the same way as you would do with a regular PostgreSQL table.
To create a distributed table, you need to first define the table schema. To do so, you can define a table using the `CREATE TABLE <http://www.postgresql.org/docs/9.6/static/sql-createtable.html>`_ statement in the same way as you would do with a regular PostgreSQL table.

::

Expand Down
4 changes: 2 additions & 2 deletions dist_tables/dml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Inserting Data
Single row inserts
$$$$$$$$$$$$$$$$$$

To insert data into distributed tables, you can use the standard PostgreSQL `INSERT <http://www.postgresql.org/docs/9.5/static/sql-insert.html>`_ commands. As an example, we pick two rows randomly from the Github Archive dataset.
To insert data into distributed tables, you can use the standard PostgreSQL `INSERT <http://www.postgresql.org/docs/9.6/static/sql-insert.html>`_ commands. As an example, we pick two rows randomly from the Github Archive dataset.

::

Expand Down Expand Up @@ -41,7 +41,7 @@ For example:
Single-Shard Updates and Deletion
---------------------------------

You can also update or delete rows from your tables, using the standard PostgreSQL `UPDATE <http://www.postgresql.org/docs/9.5/static/sql-update.html>`_ and `DELETE <http://www.postgresql.org/docs/9.5/static/sql-delete.html>`_ commands.
You can also update or delete rows from your tables, using the standard PostgreSQL `UPDATE <http://www.postgresql.org/docs/9.6/static/sql-update.html>`_ and `DELETE <http://www.postgresql.org/docs/9.6/static/sql-delete.html>`_ commands.

::

Expand Down
2 changes: 1 addition & 1 deletion dist_tables/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
PostgreSQL extensions
---------------------

Citus provides distributed functionality by extending PostgreSQL using the hook and extension APIs. This allows users to benefit from the features that come with the rich PostgreSQL ecosystem. These features include, but aren’t limited to, support for a wide range of `data types <http://www.postgresql.org/docs/9.5/static/datatype.html>`_ (including semi-structured data types like jsonb and hstore), `operators and functions <http://www.postgresql.org/docs/9.5/static/functions.html>`_, full text search, and other extensions such as `PostGIS <http://postgis.net/>`_ and `HyperLogLog <https://github.com/aggregateknowledge/postgresql-hll>`_. Further, proper use of the extension APIs enable compatibility with standard PostgreSQL tools such as `pgAdmin <http://www.pgadmin.org/>`_, `pg_backup <http://www.postgresql.org/docs/9.5/static/backup.html>`_, and `pg_upgrade <http://www.postgresql.org/docs/9.5/static/pgupgrade.html>`_.
Citus provides distributed functionality by extending PostgreSQL using the hook and extension APIs. This allows users to benefit from the features that come with the rich PostgreSQL ecosystem. These features include, but aren’t limited to, support for a wide range of `data types <http://www.postgresql.org/docs/9.6/static/datatype.html>`_ (including semi-structured data types like jsonb and hstore), `operators and functions <http://www.postgresql.org/docs/9.6/static/functions.html>`_, full text search, and other extensions such as `PostGIS <http://postgis.net/>`_ and `HyperLogLog <https://github.com/aggregateknowledge/postgresql-hll>`_. Further, proper use of the extension APIs enable compatibility with standard PostgreSQL tools such as `pgAdmin <http://www.pgadmin.org/>`_, `pg_backup <http://www.postgresql.org/docs/9.6/static/backup.html>`_, and `pg_upgrade <http://www.postgresql.org/docs/9.6/static/pgupgrade.html>`_.

As Citus is an extension which can be installed on any PostgreSQL instance, you can directly use other extensions such as hstore, hll, or PostGIS with Citus. However, there are two things to keep in mind. First, while including other extensions in shared_preload_libraries, you should make sure that Citus is the first extension. Secondly, you should create the extension on both the master and the workers before starting to use it.

Expand Down
2 changes: 1 addition & 1 deletion dist_tables/querying.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Querying Distributed Tables (SQL)
$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$

As discussed in the previous sections, Citus is an extension which extends the latest PostgreSQL for distributed execution. This means that you can use standard PostgreSQL `SELECT <http://www.postgresql.org/docs/9.5/static/sql-select.html>`_ queries on the Citus master for querying. Citus will then parallelize the SELECT queries involving complex selections, groupings and orderings, and JOINs to speed up the query performance. At a high level, Citus partitions the SELECT query into smaller query fragments, assigns these query fragments to workers, oversees their execution, merges their results (and orders them if needed), and returns the final result to the user.
As discussed in the previous sections, Citus is an extension which extends the latest PostgreSQL for distributed execution. This means that you can use standard PostgreSQL `SELECT <http://www.postgresql.org/docs/9.6/static/sql-select.html>`_ queries on the Citus master for querying. Citus will then parallelize the SELECT queries involving complex selections, groupings and orderings, and JOINs to speed up the query performance. At a high level, Citus partitions the SELECT query into smaller query fragments, assigns these query fragments to workers, oversees their execution, merges their results (and orders them if needed), and returns the final result to the user.

In the following sections, we discuss the different types of queries you can run using Citus.

Expand Down
2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Citus Documentation
====================

Welcome to the documentation for Citus 5.2! Citus horizontally scales PostgreSQL across commodity servers using sharding and replication. Its query engine parallelizes incoming SQL queries across these servers to enable real-time responses on large datasets.
Welcome to the documentation for Citus 6.0! Citus horizontally scales PostgreSQL across commodity servers using sharding and replication. Its query engine parallelizes incoming SQL queries across these servers to enable real-time responses on large datasets.

The documentation explains how you can install Citus and then provides
instructions to design, build, query, and maintain your Citus cluster. It also
Expand Down
4 changes: 2 additions & 2 deletions installation/multi_machine_aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ At this step, you have completed the installation process and are ready to use t

::

/usr/pgsql-9.5/bin/psql -h localhost -d postgres
/usr/pgsql-9.6/bin/psql -h localhost -d postgres
select * from master_get_active_worker_nodes();


Expand All @@ -124,7 +124,7 @@ Similarly to restart the database, you can use the command:

::

/usr/pgsql-9.5/bin/pg_ctl -D /data/base -l logfile restart
/usr/pgsql-9.6/bin/pg_ctl -D /data/base -l logfile restart

.. note::
You typically want to avoid making changes to resources created by CloudFormation, such as terminating EC2 instances. To shut the cluster down, you can simply delete the stack in the CloudFormation console.
Expand Down
14 changes: 8 additions & 6 deletions installation/production_deb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,24 @@ Steps to be executed on all nodes
::

# install the server and initialize db
sudo apt-get -y install postgresql-9.5-citus
sudo apt-get -y install postgresql-9.6-citus

# preload citus extension
sudo pg_conftool 9.5 main set shared_preload_libraries citus
sudo pg_conftool 9.6 main set shared_preload_libraries citus

This installs centralized configuration in `/etc/postgresql/9.5/main`, and creates a database in `/var/lib/postgresql/9.5/main`.
This installs centralized configuration in `/etc/postgresql/9.6/main`, and creates a database in `/var/lib/postgresql/9.6/main`.

**3. Configure connection and authentication**

Before starting the database let's change its access permissions. By default the database server listens only to clients on localhost. As a part of this step, we instruct it to listen on all IP interfaces, and then configure the client authentication file to allow all incoming connections from the local network.

::

sudo pg_conftool 9.5 main set listen_addresses '*'
sudo pg_conftool 9.6 main set listen_addresses '*'

::

sudo vi /etc/postgresql/9.5/main/pg_hba.conf
sudo vi /etc/postgresql/9.6/main/pg_hba.conf

::

Expand All @@ -54,7 +54,7 @@ Before starting the database let's change its access permissions. By default the
host all all ::1/128 trust

.. note::
Your DNS settings may differ. Also these settings are too permissive for some environments. The PostgreSQL manual `explains how <http://www.postgresql.org/docs/9.5/static/auth-pg-hba-conf.html>`_ to make them more restrictive.
Your DNS settings may differ. Also these settings are too permissive for some environments. The PostgreSQL manual `explains how <http://www.postgresql.org/docs/9.6/static/auth-pg-hba-conf.html>`_ to make them more restrictive.

**4. Start database servers, create Citus extension**

Expand Down Expand Up @@ -90,6 +90,8 @@ worker-102). Add the workers' DNS names and server ports to the table.

sudo -i -u postgres psql -c "SELECT * from master_add_node('worker-101', 5432);"
sudo -i -u postgres psql -c "SELECT * from master_add_node('worker-102', 5432);"
echo "worker-101 5432" | sudo -u postgres tee -a /var/lib/postgresql/9.6/main/pg_worker_list.conf
echo "worker-102 5432" | sudo -u postgres tee -a /var/lib/postgresql/9.6/main/pg_worker_list.conf

Note that you can also add this information by editing the file using your favorite editor.

Expand Down
20 changes: 11 additions & 9 deletions installation/production_rhel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ Steps to be executed on all nodes
::

# install PostgreSQL with Citus extension
sudo yum install -y citus_95
sudo yum install -y citus_96
# initialize system database (using RHEL 6 vs 7 method as necessary)
sudo service postgresql-9.5 initdb || sudo /usr/pgsql-9.5/bin/postgresql95-setup initdb
sudo service postgresql-9.6 initdb || sudo /usr/pgsql-9.6/bin/postgresql96-setup initdb
# preload citus extension
echo "shared_preload_libraries = 'citus'" | sudo tee -a /var/lib/pgsql/9.5/data/postgresql.conf
echo "shared_preload_libraries = 'citus'" | sudo tee -a /var/lib/pgsql/9.6/data/postgresql.conf

PostgreSQL adds version-specific binaries in `/usr/pgsql-9.5/bin`, but you'll usually just need psql, whose latest version is added to your path, and managing the server itself can be done with the *service* command.
PostgreSQL adds version-specific binaries in `/usr/pgsql-9.6/bin`, but you'll usually just need psql, whose latest version is added to your path, and managing the server itself can be done with the *service* command.

**3. Configure connection and authentication**

Before starting the database let's change its access permissions. By default the database server listens only to clients on localhost. As a part of this step, we instruct it to listen on all IP interfaces, and then configure the client authentication file to allow all incoming connections from the local network.

::

sudo vi /var/lib/pgsql/9.5/data/postgresql.conf
sudo vi /var/lib/pgsql/9.6/data/postgresql.conf

::

Expand All @@ -48,7 +48,7 @@ Before starting the database let's change its access permissions. By default the

::

sudo vi /var/lib/pgsql/9.5/data/pg_hba.conf
sudo vi /var/lib/pgsql/9.6/data/pg_hba.conf

::

Expand All @@ -61,16 +61,16 @@ Before starting the database let's change its access permissions. By default the
host all all ::1/128 trust

.. note::
Your DNS settings may differ. Also these settings are too permissive for some environments. The PostgreSQL manual `explains how <http://www.postgresql.org/docs/9.5/static/auth-pg-hba-conf.html>`_ to make them more restrictive.
Your DNS settings may differ. Also these settings are too permissive for some environments. The PostgreSQL manual `explains how <http://www.postgresql.org/docs/9.6/static/auth-pg-hba-conf.html>`_ to make them more restrictive.

**4. Start database servers, create Citus extension**

::

# start the db server
sudo service postgresql-9.5 restart
sudo service postgresql-9.6 restart
# and make it start automatically when computer does
sudo chkconfig postgresql-9.5 on
sudo chkconfig postgresql-9.6 on

You must add the Citus extension to **every database** you would like to use in a cluster. The following example adds the extension to the default database which is named `postgres`.

Expand All @@ -97,6 +97,8 @@ worker-102). Add the workers' DNS names and server ports to the table.

sudo -i -u postgres psql -c "SELECT * from master_add_node('worker-101', 5432);"
sudo -i -u postgres psql -c "SELECT * from master_add_node('worker-102', 5432);"
echo "worker-101 5432" | sudo -u postgres tee -a /var/lib/pgsql/9.6/data/pg_worker_list.conf
echo "worker-102 5432" | sudo -u postgres tee -a /var/lib/pgsql/9.6/data/pg_worker_list.conf

Note that you can also add this information by editing the file using your favorite editor.

Expand Down
2 changes: 1 addition & 1 deletion installation/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Requirements
############

Citus works with modern 64-bit Linux and most Unix based operating systems. Citus 5.2 requires PostgreSQL 9.5 or later versions.
Citus works with modern 64-bit Linux and most Unix based operating systems. Citus 6.0 requires PostgreSQL 9.5 or later versions.

Before setting up a Citus cluster, you should ensure that the network and firewall settings are configured to allow:

Expand Down
6 changes: 3 additions & 3 deletions installation/single_machine_deb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Ubuntu or Debian

This section describes the steps needed to set up a single-node Citus cluster on your own Linux machine from deb packages.

**1. Install PostgreSQL 9.5 and the Citus extension**
**1. Install PostgreSQL 9.6 and the Citus extension**

::

# Add Citus repository for package manager
curl https://install.citusdata.com/community/deb.sh | sudo bash

# install the server and initialize db
sudo apt-get -y install postgresql-9.5-citus
sudo apt-get -y install postgresql-9.6-citus


**2. Initialize the Cluster**
Expand All @@ -30,7 +30,7 @@ Let's create directories for those nodes to store their data. For convenience in
sudo su - postgres

# include path to postgres binaries
export PATH=$PATH:/usr/lib/postgresql/9.5/bin
export PATH=$PATH:/usr/lib/postgresql/9.6/bin

cd ~
mkdir -p citus/master citus/worker1 citus/worker2
Expand Down
2 changes: 1 addition & 1 deletion installation/single_machine_osx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ OS X

This section will show you how to create a Citus cluster on a single OS X machine.

**1. Install PostgreSQL 9.5 and the Citus extension**
**1. Install PostgreSQL 9.6 and the Citus extension**

Use our `Homebrew <http://brew.sh/>`_ package to extend PostgreSQL with Citus.

Expand Down
6 changes: 3 additions & 3 deletions installation/single_machine_rhel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Fedora, CentOS, or Red Hat

This section describes the steps needed to set up a single-node Citus cluster on your own Linux machine from RPM packages.

**1. Install PostgreSQL 9.5 and the Citus extension**
**1. Install PostgreSQL 9.6 and the Citus extension**

::

# Add Citus repository for package manager
curl https://install.citusdata.com/community/rpm.sh | sudo bash

# install Citus extension
sudo yum install -y citus_95
sudo yum install -y citus_96

**2. Initialize the Cluster**

Expand All @@ -29,7 +29,7 @@ Let's create directories for those nodes to store their data. For convenience in
sudo su - postgres

# include path to postgres binaries
export PATH=$PATH:/usr/pgsql-9.5/bin
export PATH=$PATH:/usr/pgsql-9.6/bin

cd ~
mkdir -p citus/master citus/worker1 citus/worker2
Expand Down

0 comments on commit 5d72f03

Please sign in to comment.