aboutsummaryrefslogtreecommitdiff
path: root/vendor/github.com/jackc/pgx/examples/todo/README.md
diff options
context:
space:
mode:
authorFelix Hanley <felix@userspace.com.au>2017-06-11 13:25:57 +0000
committerFelix Hanley <felix@userspace.com.au>2017-06-11 13:29:15 +0000
commit3185a43420dab2efb85aa601bdfe267e8b2e11f2 (patch)
tree846c21d92f7089e3e43c2fec3dbee90aef938f9b /vendor/github.com/jackc/pgx/examples/todo/README.md
parent3291eddb975a1df77975d8083599b5f3a85afaba (diff)
downloaddhtsearch-3185a43420dab2efb85aa601bdfe267e8b2e11f2.tar.gz
dhtsearch-3185a43420dab2efb85aa601bdfe267e8b2e11f2.tar.bz2
Add torrent tagging
- Move to postgresql to reduce locking issues - Move ih hash to single thread - Clean up stuff
Diffstat (limited to 'vendor/github.com/jackc/pgx/examples/todo/README.md')
-rw-r--r--vendor/github.com/jackc/pgx/examples/todo/README.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/vendor/github.com/jackc/pgx/examples/todo/README.md b/vendor/github.com/jackc/pgx/examples/todo/README.md
new file mode 100644
index 0000000..eb3d95b
--- /dev/null
+++ b/vendor/github.com/jackc/pgx/examples/todo/README.md
@@ -0,0 +1,72 @@
+# Description
+
+This is a sample todo list implemented using pgx as the connector to a
+PostgreSQL data store.
+
+# Usage
+
+Create a PostgreSQL database and run structure.sql into it to create the
+necessary data schema.
+
+Example:
+
+ createdb todo
+ psql todo < structure.sql
+
+Build todo:
+
+ go build
+
+## Connection configuration
+
+The database connection is configured via enviroment variables.
+
+* TODO_DB_HOST - defaults to localhost
+* TODO_DB_USER - defaults to current OS user
+* TODO_DB_PASSWORD - defaults to empty string
+* TODO_DB_DATABASE - defaults to todo
+
+You can either export them then run todo:
+
+ export TODO_DB_HOST=/private/tmp
+ ./todo list
+
+Or you can prefix the todo execution with the environment variables:
+
+ TODO_DB_HOST=/private/tmp ./todo list
+
+## Add a todo item
+
+ ./todo add 'Learn go'
+
+## List tasks
+
+ ./todo list
+
+## Update a task
+
+ ./todo add 1 'Learn more go'
+
+## Delete a task
+
+ ./todo remove 1
+
+# Example Setup and Execution
+
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ createdb todo
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ psql todo < structure.sql
+ Expanded display is used automatically.
+ Timing is on.
+ CREATE TABLE
+ Time: 6.363 ms
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ go build
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ export TODO_DB_HOST=/private/tmp
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ ./todo list
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ ./todo add 'Learn Go'
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ ./todo list
+ 1. Learn Go
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ ./todo update 1 'Learn more Go'
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ ./todo list
+ 1. Learn more Go
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ ./todo remove 1
+ jack@hk-47~/dev/go/src/github.com/jackc/pgx/examples/todo$ ./todo list