Skip to content

Add example showing how to init compound indexes #21

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.

Sign up for GitHub

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

Open
blakek wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add example showing how to init compound indexes #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 40 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ r.init({
},
'address'
]
})
)
.then(function (conn) {
// All tables and indexes have been created
});
Expand All @@ -54,7 +54,7 @@ r.init({
'yet_another_table',
'one_last_table',
]
})
)
.then(function (conn) {
// All tables and indexes have been created
});
Expand All @@ -80,7 +80,7 @@ r.init({
},
'anotherTable'
]
})
)
.then(function (conn) {
// All tables and indexes have been created
});
Expand Down Expand Up @@ -108,7 +108,7 @@ r.init({
}]
},
]
})
)
.then(function (conn) {
// All tables and indexes have been created
});
Expand All @@ -135,7 +135,7 @@ r.init({
}]
},
]
})
)
.then(function (conn) {
// All tables and indexes have been created
});
Expand Down Expand Up @@ -165,11 +165,44 @@ r.init({
}]
},
]
})
)
.then(function (conn) {
// All tables and indexes have been created
});
```

### Instantiating a database with 1 table with a compound index and a simple index

You can use the `indexFunction` attribute as mentioned above to also create compound indexes.

```javascript
var r = require('rethinkdb')
require('rethinkdb-init')(r)

r.init(
{
host: 'localhost',
port: 28015,
db: 'helloDatabase'
},
[
{
name: 'users',
indexes: [
{
name: 'full_name',
indexFunction: [r.row('last_name'), r.row('first_name')]
}
]
}
]
)
.then(function(conn) {
// All tables and indexes have been created
})

```

### Instantiating a database with 1 table with a different primaryKey, soft durability, 2 replicas, and 2 shards

You can pass a `primaryKey`, `durability`, `replicas`, or `shards` attribute to a table and it will be passed along to the [`tableCreate`](http://rethinkdb.com/api/javascript/table_create/) function.
Expand All @@ -193,7 +226,7 @@ r.init({
shards: 2
},
]
})
)
.then(function (conn) {
// All tables and indexes have been created
});
Expand Down