Introduction to RethinkDB : OpenWest

Workshop given at OpenWest conference in Orem, Utah. May 9, 2015.

Transcript

1. RethinkDB The database for the realtime web OpenWest Orem, Utah May 10, 2015
2. Jorge Silva @thejsj Developer Evangelist @ RethinkDB
3. Introduction What is RethinkDB?
4. What is RethinkDB? • Open source database for building realtime web applications • NoSQL database that stores schemaless JSON documents • Distributed database that is easy to scale
5. Built for Realtime Apps • Subscribe to change notifications from database queries • No more polling — the database pushes changes to your app • Reduce the amount of plumbing needed to stream live updates
6. RethinkDB Structure Database → Table → Document MySQL: Database → Table → Row MongoDB: Database → Collection → Document
7. Sample Document { "name": "Will Riker", "position": "Commander", "height": 193, "birthdate": Mon Aug 19 2335, "ships": [ { "name": "USS Pegasus" }, { "name": "USS Potemkin" }, { "name": "USS Enterprise" }, ], ... }
8. Introduction to ReQL RethinkDB Query Language
9. Introduction to ReQL • ReQL embeds natively into your programming language • Compose ReQL queries by chaining commands
10. Anatomy of a ReQL Query r.table("users") .pluck("last_name") .distinct().count() Number of unique last names
11. Anatomy of a ReQL Query r.table("users") .pluck("last_name") .distinct().count() Access a database table
12. Anatomy of a ReQL Query r.table("users") .pluck("last_name") .distinct().count() Isolate a document property
13. Anatomy of a ReQL Query r.table("users") .pluck("last_name") .distinct().count() Consolidate duplicate values
14. Anatomy of a ReQL Query r.table("users") .pluck("last_name") .distinct().count() Display the number of items
15. Sample ReQL Queries r.table("users") .filter(r.row("age").gt(30)) r.table(“posts") .eqJoin(“user”, r.table(“users”)) .zip() r.table("posts") .filter({status: "draft"}) .update({status: "published"})
16. ReQL Commands • Transformations: map, orderBy, skip, limit, slice • Aggregations: group, reduce, count, sum, avg, min, max, distinct, contains • Documents: row, pluck, without, merge, append, difference, keys, hasFields, spliceAt • Writing: insert, update, replace, delete • Control: forEach, range, branch, do, coerceTo, expr
17. Understanding ReQL • Client driver translates ReQL queries into wire protocol • In JS use e.g. the mul and gt commands instead of the normal operators
18. Additional ReQL Features • Geospatial indexing for location- based queries • Date and time functions for time data • Support for storing binary objects
19. Running Queries https://github.com/thejsj/rethinkdb-workshop
20. http://rethinkdb-chat.thejsj.com:10001/ Running Queries
21. Realtime Updates Working with Changefeeds
22. Subscribe to change notifications on database queries Changefeeds
23. r.table("users").changes() Track changes on the users table Changefeeds
24. Changefeeds • The changes command returns a cursor that receives updates • Each update includes the new and old value of the modified record
25. Changefeeds r.table("users").changes() r.table("users") .insert({name: "Bob"}) Changefeed output: { new_val: { id: '362ae837-2e29-4695-adef-4fa415138f90', name: 'Bob', ... }, old_val: null }
26. Changefeeds r.table("users").changes() r.table("users") .filter({name: "Bob"}).delete() Changefeed output: { new_val: null, old_val: { id: '362ae837-2e29-4695-adef-4fa415138f90', name: 'Bob', ... } }
27. Changefeeds r.table("users").changes() r.table("users") .get("362ae837-2e29-4695-adef-4fa415138f90") .update({name: "Bobbby"}) Changefeed output: { new_val: { id: '362ae837-2e29-4695-adef-4fa415138f90', name: 'Bobby' }, old_val: { id: '362ae837-2e29-4695-adef-4fa415138f90', name: 'Bob' } }
28. Changefeeds r.table("players") .orderBy({index: r.desc("score")}) .limit(3).changes() Track top three players by score Chain the changes command to an actual ReQL query:
29. Changefeeds r.table("table").get(ID).changes() r.table("table").getAll(ID).changes() r.table("table").between(X, Y).changes() r.table("table").filter(CONDITION).changes() r.table("table").union(ID).changes() r.table("table").map(FUNCTION).changes() r.table("table").min(INDEX).changes() r.table("table").max(INDEX).changes() r.table("table").orderBy(INDEX) .limit(N).changes() Commands that currently work with changefeeds:
30. Using Changefeeds
31. Building Web Apps Using RethinkDB in Node
32. Client Driver • Use a RethinkDB client driver to access the database in your app • Official drivers available for Ruby, Python, and JavaScript • Third-party drivers available for other languages like Go and Clojure
33. > Client Driver Install the JS client driver from NPM in your Node.js project: $ npm install rethinkdb --save
34. Client Driver var r = require("rethinkdb"); r.connect().then(function(conn) { return r.table("users") .insert({name: “Bob”}).run(conn) .finally(function () { conn.close(); }); }).then(function() { // Documented inserted }); Add Bob to the “users” table
35. Client Driver var r = require("rethinkdb"); r.connect().then(function(conn) { return r.table("users") .insert({name: “Bob"}).run(conn) .finally(function () { conn.close(); }); }).then(function(output) { console.log(output); }); Import the RethinkDB module
36. Client Driver var r = require("rethinkdb"); r.connect().then(function(conn) { return r.table("users") .insert({name: “Bob”}).run(conn) .finally(function () { conn.close(); }); }).then(function(output) { console.log(output); }); Connect to the database
37. Client Driver var r = require("rethinkdb"); r.connect().then(function(conn) { return r.table("users") .insert({name: “Bob”}).run(conn) .finally(function () { conn.close(); }); }).then(function(output) { console.log(output); }); ReQL query that inserts a record
38. Client Driver var r = require("rethinkdb"); r.connect().then(function(conn) { return r.table("users") .insert({name: “Bob”}).run(conn) .finally(function () { conn.close(); }); }).then(function(output) { console.log(output); }); Run the query on a connection
39. Client Driver var r = require("rethinkdb"); r.connect().then(function(conn) { return r.table("users") .insert({name: “Bob"}).run(conn) .finally(function () { conn.close(); }); }).then(function(output) { console.log(output); }); Display query response
40. Client Driver var r = require("rethinkdb"); r.connect().then(function(conn) { return r.table("users") .insert({name: “Bob"}).run(conn) .finally(function () { conn.close(); }); }).then(function(output) { console.log(output); }).error(function(err) { console.log("Failed:", err); }); Handle errors emitted by Promise
41. Using Changefeeds r.connect().then(function(conn) { return r.table("fellowship") .changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, item) { console.log(item); }); }); Display every change on the “fellowship” table
42. Using Changefeeds Attach a changefeed to the table r.connect().then(function(conn) { return r.table("fellowship") .changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, item) { console.log(item); }); });
43. Using Changefeeds Iterate over every value passed into the cursor r.connect().then(function(conn) { return r.table("fellowship") .changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, item) { console.log(item); }); });
44. Using Changefeeds r.connect().then(function(conn) { return r.table("fellowship") .changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, item) { console.log(item); }); }); Display received changes in the console
45. Using Socket.io • Powerful framework for realtime client/server communication • Supports WebSockets, long polling, and other transports • Lets you send JSON messages between your app and frontend
46. Socket.io (Server) var sockio = require("socket.io"); var app = require("express")(); var r = require("rethinkdb"); var io = sockio.listen(app.listen(8090)); r.connect().then(function(conn) { return r.table("players") .orderBy({index: r.desc("score")}) .limit(5).changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, data) { io.sockets.emit("update", data); }); }); Broadcast score changes over Socket.io
47. Socket.io (Server) var sockio = require("socket.io"); var app = require("express")(); var r = require("rethinkdb"); var io = sockio.listen(app.listen(8090)); r.connect().then(function(conn) { return r.table("players") .orderBy({index: r.desc("score")}) .limit(5).changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, data) { io.sockets.emit("update", data); }); }); Load the Socket.io module
48. Socket.io (Server) var sockio = require("socket.io"); var app = require("express")(); var r = require("rethinkdb"); var io = sockio.listen(app.listen(8090)); r.connect().then(function(conn) { return r.table("players") .orderBy({index: r.desc("score")}) .limit(5).changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, data) { io.sockets.emit("update", data); }); }); Instantiate Socket.io server
49. Socket.io (Server) var sockio = require("socket.io"); var app = require("express")(); var r = require("rethinkdb"); var io = sockio.listen(app.listen(8090)); r.connect().then(function(conn) { return r.table("players") .orderBy({index: r.desc("score")}) .limit(5).changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, data) { io.sockets.emit("update", data); }); }); Attach a changefeed to the query
50. Socket.io (Server) var sockio = require("socket.io"); var app = require("express")(); var r = require("rethinkdb"); var io = sockio.listen(app.listen(8090)); r.connect().then(function(conn) { return r.table("players") .orderBy({index: r.desc("score")}) .limit(5).changes().run(conn); }) .then(function(cursor) { cursor.each(function(err, data) { io.sockets.emit("update", data); }); }); Broadcast updates to all Socket.io connections
51. Socket.io (Client) <html> <head> <title>Real-time web app</title> <script src="/socket.io/socket.io.js"></script> <script> var socket = io.connect(); socket.on("update", function(data) { console.log("Update:", data); }); Receive Socket.io updates on frontend
52. Socket.io (Client) <html> <head> <title>Real-time web app</title> <script src="/socket.io/socket.io.js"></script> <script> var socket = io.connect(); socket.on("update", function(data) { console.log("Update:", data); }); Load the Socket.io client script
53. Socket.io (Client) <html> <head> <title>Real-time web app</title> <script src="/socket.io/socket.io.js"></script> <script> var socket = io.connect(); socket.on("update", function(data) { console.log("Update:", data); }); Connect to the Socket.io server
54. Socket.io (Client) <html> <head> <title>Real-time web app</title> <script src="/socket.io/socket.io.js"></script> <script> var socket = io.connect(); socket.on("update", function(data) { console.log("Update:", data); }); Create handler for “update” messages
55. Socket.io (Client) <html> <head> <title>Real-time web app</title> <script src="/socket.io/socket.io.js"></script> <script> var socket = io.connect(); socket.on("update", function(data) { console.log("Update:", data); }); Display update in browser console
56. Tutorial: Building a chat app
57. #1: Clone the repository git clone git@github.com:thejsj/ rethinkdb-workshp.git or https://github.com/thejsj/rethinkdb- workshop/tarball/master
58. #2: Go to config/default.js 6QEBUF
    ZPVS
    3FUIJOL%#
    EBUBCBTF
    DPOHVSBUJPO var config = { 'rethinkdb': { 'host': ‘rethinkdb-chat.thejsj.com’, 'port': 10002, 'db': ‘GITHUB_HANDLE_rethinkdb_workshop’ },
59. #3: Install Dependencies // Go to the project directory cd rethinkdb-workshop // Install dependencies npm install // Start server npm run dev // or `node server`
60. #4: Go to server/index.js -PPL
    GPS
    UIF
    DPNNFOUT
    JO
    PSEFS
    UP
    XSJUF
    UIF
    DPSSFDU
    3F2-
    RVFSJFT // Step 1 // Write a query…
61. Connections *O
    UIJT
    BQQ
    UIF
    r
    PCKFDU
    DPOUBJOT
    B
    DPOOFDUJPO r.table(‘messages’).run(r.conn);
62. #5: Switch database $POOFDU
    UP
    UIF
    GPMMPXJOH
    EBUBCBTF
    TP
    XF
    DBO
    BMM
    TIBSF
    NFTTBHFT var config = { 'rethinkdb': { 'host': ‘rethinkdb-chat.thejsj.com’, 'port': 10002, 'db': ‘main_rethinkdb_workshop’ },
63. Additional Resources • RethinkDB website:
 http://rethinkdb.com • RethinkDB cookbook:
 http://rethinkdb.com/docs/cookbook • RethinkDB installation:
 http://rethinkdb.com/docs/install/