Add todo CLI app example of CRUD actions

2014-07-17 09:16:13 -05:00
parent f7171f34e7
commit a2a828134c
4 changed files with 217 additions and 0 deletions
@@ -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