README.md in flare-up-0.9 vs README.md in flare-up-0.10
- old
+ new
@@ -32,10 +32,11 @@
Options:
[--aws-access-key=AWS_ACCESS_KEY] # Required unless ENV['AWS_ACCESS_KEY_ID'] is set.
[--aws-secret-key=AWS_SECRET_KEY] # Required unless ENV['AWS_SECRET_ACCESS_KEY'] is set.
[--redshift-username=REDSHIFT_USERNAME] # Required unless ENV['REDSHIFT_USERNAME'] is set.
[--redshift-password=REDSHIFT_PASSWORD] # Required unless ENV['REDSHIFT_PASSWORD'] is set.
+ [--redshift-port=REDSHIFT_PORT] # Optional (defaults to 5439)
[--column-list=one two three] # A space-separated list of columns, should your DATA_SOURCE require it
[--copy-options=COPY_OPTIONS] # Appended to the end of the COPY command; enclose "IN QUOTES"
[--colorize-output], [--no-colorize-output] # Should Flare-up colorize its output?
# Default: true
```
@@ -48,10 +49,11 @@
Options:
[--column-list=COLUMN_LIST] # Required. A space-separated list of columns with their data-types, enclose "IN QUOTES"
[--redshift-username=REDSHIFT_USERNAME] # Required unless ENV['REDSHIFT_USERNAME'] is set.
[--redshift-password=REDSHIFT_PASSWORD] # Required unless ENV['REDSHIFT_PASSWORD'] is set.
+ [--redshift-port=REDSHIFT_PORT] # Optional (defaults to 5439)
[--colorize-output], [--no-colorize-output] # Should Flare-up colorize its output?
# Default: true
```
### DROP TABLE
@@ -61,14 +63,29 @@
flare-up drop_table REDSHIFT_ENDPOINT DATABASE TABLE
Options:
[--redshift-username=REDSHIFT_USERNAME] # Required unless ENV['REDSHIFT_USERNAME'] is set.
[--redshift-password=REDSHIFT_PASSWORD] # Required unless ENV['REDSHIFT_PASSWORD'] is set.
+ [--redshift-port=REDSHIFT_PORT] # Optional (defaults to 5439)
[--colorize-output], [--no-colorize-output] # Should Flare-up colorize its output?
# Default: true
```
+### TRUNCATE
+
+```
+Usage:
+ flare-up truncate REDSHIFT_ENDPOINT DATABASE TABLE
+
+Options:
+ [--redshift-username=REDSHIFT_USERNAME] # Required unless ENV['REDSHIFT_USERNAME'] is set.
+ [--redshift-password=REDSHIFT_PASSWORD] # Required unless ENV['REDSHIFT_PASSWORD'] is set.
+ [--redshift-port=REDSHIFT_PORT] # Optional (defaults to 5439)
+ [--colorize-output], [--no-colorize-output] # Should Flare-up colorize its output?
+ # Default: true
+```
+
## Sample Usage
Note that these examples assume you have credentials set as environment variables.
### CREATE TABLE
@@ -104,5 +121,19 @@
drop_table \
flare-up-test.cskjnp4xvaje.us-west-2.redshift.amazonaws.com \
dev \
hearthstone_cards
```
+
+### TRUNCATE
+
+```
+> flare-up \
+ truncate \
+ flare-up-test.cskjnp4xvaje.us-west-2.redshift.amazonaws.com \
+ dev \
+ hearthstone_cards
+```
+
+## License
+
+This project is Copyright (c) 2015, Sharethrough and licensed under the [MIT License](LICENSE.md).