Skip to content

Commit

Permalink
version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
extrabacon committed Oct 24, 2013
1 parent d4634ec commit e915e04
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 31 deletions.
31 changes: 1 addition & 30 deletions README.md
Expand Up @@ -227,18 +227,14 @@ Creates the DynamoDB table represented by the schema and returns the AWS service
+ options: attributes to add to the AWS.Request instance (optional)
+ callback: the callback function to invoke with the AWS response (optional)

Callback arguments:
+ err: the error, if any
+ response: the AWS service response

```javascript
var myTable = new DynamoDBModel.Model(tableName, schema);
myTable.createTable(function (err, response) {
// table creation started
})
```

Note: table creation in DynamoDB are asynchronous. The table is not ready until its status property is set to "ACTIVE". If you need to wait for the table to become active, use the `waitForActiveTable` method.
Note: table creation in DynamoDB is asynchronous. The table is not ready until its status property is set to "ACTIVE". If you need to wait for the table to become active, use the `waitForActiveTable` method.

[AWS Documentation for CreateTable](http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html)

Expand All @@ -250,10 +246,6 @@ Deletes a single item in a table by primary key and returns the AWS service resp
+ options: attributes to add to the AWS.Request instance (optional)
+ callback: the callback function to invoke with the AWS response (optional)

Callback arguments:
+ err: the error, if any
+ response: the AWS service response

```javascript
var myTable = new DynamoDBModel.Model(tableName, schema);
myTable.deleteItem({ id: 1 }, function (err, response) {
Expand All @@ -272,10 +264,6 @@ Removes the table represented by the schema, as well as all items in the table,
+ options: attributes to add to the AWS.Request instance (optional)
+ callback: the callback function to invoke with the AWS response

Callback arguments:
+ err: the error, if any
+ response: the AWS service response

```javascript
var myTable = new DynamoDBModel.Model(tableName, schema);
myTable.deleteTable(function (err, response) {
Expand All @@ -292,10 +280,6 @@ Returns information about the table represented by the schema, including the cur
+ options: attributes to add to the AWS.Request instance (optional)
+ callback: the callback function to invoke with the AWS response

Callback arguments:
+ err: the error, if any
+ response: the AWS service response

```javascript
var myTable = new DynamoDBModel.Model(tableName, schema);
myTable.describeTable(function (err, response) {
Expand All @@ -310,10 +294,6 @@ Invokes `describeTable` repeatedly until the table status is `"ACTIVE"`.
+ pollingInterval: the delay in milliseconds between each invocation of `describeTable` (optional, default value is 3000)
+ callback: the callback function to invoke with the AWS response from `describeTable` (optional)

Callback arguments:
+ err: the error, if any
+ response: the AWS service response

```javascript
var myTable = new DynamoDBModel.Model(tableName, schema);
var pollingInterval = 5000; // 5 seconds
Expand All @@ -330,11 +310,6 @@ Retrieves a specific item based on its primary key, returning the mapped item as
+ options: attributes to add to the AWS.Request instance (optional)
+ callback: the callback function to invoke with the AWS response

Callback arguments:
+ err: the error, if any
+ item: the resulting item mapped according to the schema, or null
+ response: the AWS service response

```javascript
var myTable = new DynamoDBModel.Model(tableName, schema);
myTable.getItem({ id: 1 }, function (err, item, response) {
Expand All @@ -351,10 +326,6 @@ This method is not yet implemented.
+ options: attributes to add to the AWS.Request instance (optional)
+ callback: the callback function to invoke with the AWS response

Callback arguments:
+ err: the error, if any
+ response: the AWS service response

[AWS Documentation for ListTables](http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListTables.html)

#### Model.putItem(item, options, callback)
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "dynamodb-model",
"version": "0.0.1",
"version": "0.0.2",
"author": {
"name": "Nicolas Mercier",
"email": "nicolas@extrabacon.net"
Expand Down

0 comments on commit e915e04

Please sign in to comment.