Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker-compose support #16

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 123 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,105 +1,131 @@
Pagila
======
# Pagila Docker Compose
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think my auto formatter went nuts. If you do want this PR, I can clean this up, just let me know.


Pagila is a port of the Sakila example database available for MySQL, which was
originally developed by Mike Hillyer of the MySQL AB documentation team. It
is intended to provide a standard schema that can be used for examples in
is intended to provide a standard schema that can be used for examples in
books, tutorials, articles, samples, etc.

Pagila works against PostgreSQL 11 and above.

All the tables, data, views, and functions have been ported; some of the
changes made were:

* Changed char(1) true/false fields to true boolean fields
* The last_update columns were set with triggers to update them
* Added foreign keys
* Removed 'DEFAULT 0' on foreign keys since it's pointless with real FK's
* Used PostgreSQL built-in fulltext searching for fulltext index.
- Changed char(1) true/false fields to true boolean fields
- The last_update columns were set with triggers to update them
- Added foreign keys
- Removed 'DEFAULT 0' on foreign keys since it's pointless with real FK's
- Used PostgreSQL built-in fulltext searching for fulltext index.
Removed the need for the film_text table.
* The rewards_report function was ported to a simple SRF
- The rewards_report function was ported to a simple SRF

The schema and data for the Sakila database were made available under the BSD
license which can be found at
http://www.opensource.org/licenses/bsd-license.php.
The pagila database is made available under this license as well.

## EXAMPLE QUERY

Find late rentals:

```sql
SELECT
CONCAT(customer.last_name, ', ', customer.first_name) AS customer,
address.phone,
film.title
FROM
rental
INNER JOIN customer ON rental.customer_id = customer.customer_id
INNER JOIN address ON customer.address_id = address.address_id
INNER JOIN inventory ON rental.inventory_id = inventory.inventory_id
INNER JOIN film ON inventory.film_id = film.film_id
WHERE
rental.return_date IS NULL
AND rental_date < CURRENT_DATE
ORDER BY
title
LIMIT 5;
```

FULLTEXT SEARCH
---------------
## FULLTEXT SEARCH

Fulltext functionality is built in PostgreSQL, so parts of the schema exist
in the main schema file.
in the main schema file.

Example usage:

SELECT * FROM film WHERE fulltext @@ to_tsquery('fate&india');

SELECT \* FROM film WHERE fulltext @@ to_tsquery('fate&india');

PARTITIONED TABLES
------------------
## PARTITIONED TABLES

The payment table is designed as a partitioned table with a 6 month timespan
for the date ranges.
for the date ranges.
If you want to take full advantage of table partitioning, you need to make
sure constraint_exclusion is turned on in your database. You can do this by
setting "constraint_exclusion = on" in your postgresql.conf, or by issuing the
command "ALTER DATABASE pagila SET constraint_exclusion = on" (substitute
pagila for your database name if installing into a database with a different
name)


INSTALL NOTE
------------
## INSTALL NOTE

The pagila-data.sql file and the pagila-insert-data.sql both contain the same
data, the former using COPY commands, the latter using INSERT commands, so you
data, the former using COPY commands, the latter using INSERT commands, so you
only need to install one of them. Both formats are provided for those who have
trouble using one version or another.

VERSION HISTORY
---------------
## VERSION HISTORY

Version 2.1.0
* Replace varchar(n) with text (David Fetter)
* Match foreign key and primary key data type in some tables (Ganeshan Venkataraman)
* Change CREATE TABLE statement for customer table to use
DEFAULT nextval('customer_customer_id_seq'::regclass) for customer_id
field instead of SERIAL (Adrian Klaver).

- Replace varchar(n) with text (David Fetter)
- Match foreign key and primary key data type in some tables (Ganeshan Venkataraman)
- Change CREATE TABLE statement for customer table to use
DEFAULT nextval('customer_customer_id_seq'::regclass) for customer_id
field instead of SERIAL (Adrian Klaver).

Version 2.0
* Update schema for newer PostgreSQL versions
* Remove RULE for partitioning, add trigger support.
* Update years in sample data.
* Remove ARTICLES section from README, all links are dead.

- Update schema for newer PostgreSQL versions
- Remove RULE for partitioning, add trigger support.
- Update years in sample data.
- Remove ARTICLES section from README, all links are dead.

Version 0.10.1
* Add pagila-data-insert.sql file, added articles section

- Add pagila-data-insert.sql file, added articles section

Version 0.10
* Support for built-in fulltext. Add enum example

- Support for built-in fulltext. Add enum example

Version 0.9
* Add table partitioning example

Version 0.8
* First release of pagila
- Add table partitioning example

Version 0.8

- First release of pagila

## CREATE DATABASE ON [DOCKER](https://docs.docker.com/)

CREATE DATABASE ON [DOCKER](https://docs.docker.com/)
---------------------------
1. On terminal pull the latest postgres image:

```
docker pull postgres
```

2. Run image:

```
docker run --name postgres -e POSTGRES_PASSWORD=secret -d postgres
```

3. Run postgres and create the database:

```
docker exec -it postgres psql -U postgres
```

```
psql (13.1 (Debian 13.1-1.pgdg100+1))
Type "help" for help.
Expand All @@ -109,21 +135,24 @@ postgres-# CREATE DATABASE
postgres=\q
```

4. Create all schema objetcs (tables, etc) replace ```<local-repo>``` by your local directory :
4. Create all schema objetcs (tables, etc) replace `<local-repo>` by your local directory :

```
cat <local-repo>/pagila-schema.sql | docker exec -i postgres psql -U postgres -d pagila
```

5. Insert all data:

```
cat <local-repo>/pagila-data.sql | docker exec -i postgres psql -U postgres -d pagila
```

6. Done! Just use:

```
docker exec -it postgres psql -U postgres
```

````
postgres
psql (13.1 (Debian 13.1-1.pgdg100+1))
Expand Down Expand Up @@ -160,3 +189,57 @@ pagila=# \dt
pagila=#
```
````

## CREATE DATABASE ON [DOCKER-COMPOSE](https://docs.docker.com/compose/)

1. Run:

```
docker-compose up
```

2. Done! Just use:

```
docker exec -it postgres psql -U postgres
```

```
postgres
psql (13.1 (Debian 13.1-1.pgdg100+1))
Type "help" for help.
postgres=# \c pagila
You are now connected to database "pagila" as user "postgres".
pagila=# \dt
List of relations
Schema | Name | Type | Owner
--------+------------------+-------------------+----------
public | actor | table | postgres
public | address | table | postgres
public | category | table | postgres
public | city | table | postgres
public | country | table | postgres
public | customer | table | postgres
public | film | table | postgres
public | film_actor | table | postgres
public | film_category | table | postgres
public | inventory | table | postgres
public | language | table | postgres
public | payment | partitioned table | postgres
public | payment_p2020_01 | table | postgres
public | payment_p2020_02 | table | postgres
public | payment_p2020_03 | table | postgres
public | payment_p2020_04 | table | postgres
public | payment_p2020_05 | table | postgres
public | payment_p2020_06 | table | postgres
public | rental | table | postgres
public | staff | table | postgres
public | store | table | postgres
(21 rows)
pagila=#
```
18 changes: 18 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: "3"
volumes:
pgdata:
services:
pagila:
image: postgres:13.2
container_name: pagila
environment:
POSTGRES_PASSWORD: 123456
POSTGRES_USER: postgres
volumes:
- ./pagila-schema.sql:/docker-entrypoint-initdb.d/1-pagila-schema.sql
- ./pagila-data.sql:/docker-entrypoint-initdb.d/2-pagila-data.sql
- pgdata:/var/lib/postgresql/data
expose:
- 5432
ports:
- 5432:5432