-
Notifications
You must be signed in to change notification settings - Fork 28
/
dev_manual_examples.rb
459 lines (350 loc) · 15.4 KB
/
dev_manual_examples.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
############################################################################
# Ruby examples for https://neo4j.com/docs/developer-manual/current/drivers/
############################################################################
######################################
# Getting Started
######################################
######################################
# Example 4. Hello World
######################################
Neo4j::Driver::GraphDatabase.driver('bolt://localhost:7687',
Neo4j::Driver::AuthTokens.basic('neo4j', 'pass')) do |driver|
driver.session do |session|
greeting = session.write_transaction do |tx|
result = tx.run("CREATE (a:Greeting) SET a.message = $message RETURN a.message + ', from node ' + id(a)",
message: 'hello, world')
result.single.first
end # session auto closed at the end of the block if one given
puts greeting
end
end # driver auto closed at the end of the block if one given
######################################
# Client Application
######################################
######################################
# Example 1. The driver lifecycle
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
# on application exit
driver.close
######################################
# Example 2. Custom Address Resolver
######################################
private
def create_driver(virtual_uri, user, password, *addresses, &block)
config = { resolver: -> { addresses } }
Neo4j::Driver::GraphDatabase.driver(virtual_uri, Neo4j::Driver::AuthTokens.basic(user, password), config, &block)
end
def add_person(name)
username = 'neo4j'
password = 'pass'
create_driver('bolt+routing://x.acme.com', username, password, ServerAddress.of('a.acme.com', 7676),
ServerAddress.of('b.acme.com', 8787), ServerAddress.of('c.acme.com', 9898)) do |driver|
driver.session { |session| session.run('CREATE (a:Person {name: $name})', name: name) }
end
end
######################################
# Table 3 Neo4j Aura Secured with full certificate
######################################
uri = 'neo4j+s://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
# If you do not have at least the Ruby Driver 4.0.1 patch installed, you will need this snippet instead:
uri = 'neo4j://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password), encryption: true)
######################################
# Table 4 Neo4j 4.x Unsecured
######################################
uri = 'neo4j://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
######################################
# Table 5 Neo4j 4.x Secured with full certificate
######################################
uri = 'neo4j+s://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
# If you do not have at least the Ruby Driver 4.0.1 patch installed, you will need this snippet instead:
uri = 'neo4j://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password), encryption: true)
######################################
# Table 6 Neo4j 4.x Secured with self-signed certificate
######################################
uri = 'neo4j+ssc://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
# If you do not have at least the Ruby Driver 4.0.1 patch installed, you will need this snippet instead:
uri = 'neo4j://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password),
trust_strategy: { strategy: :trust_all_certificates }, encryption: true)
######################################
# Table 7 Neo4j 3.x Secured with full certificate
######################################
uri = 'neo4j+s://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
# If you do not have at least the Ruby Driver 4.0.1 patch installed, you will need this snippet instead:
uri = 'neo4j://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password), encryption: true)
######################################
# Table 8 Neo4j 3.x Secured with self-signed certificate
######################################
uri = 'neo4j+ssc://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
# If you do not have at least the Ruby Driver 4.0.1 patch installed, you will need this snippet instead:
uri = 'neo4j://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password),
trust_strategy: { strategy: :trust_all_certificates }, encryption: true)
######################################
# Table 9 Neo4j 3.x Unsecured
######################################
uri = 'neo4j://graph.example.com:7687'
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
######################################
# Example 4. Basic authentication
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password))
######################################
# Example 5. Kerberos authentication
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.kerberos(ticket))
######################################
# Example 6. Bearer authentication
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.bearer(bearer_token))
######################################
# Example 7. Custom authentication
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.custom(principal, credentials, realm,
scheme, parameters))
######################################
# Example 8. Configure connection pool
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password),
max_connection_lifetime: 30.minutes,
max_connection_pool_size: 50,
connection_acquisition_timeout: 2.minutes)
######################################
# Example 9. Configure connection timeout
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password),
connection_timeout: 15.seconds)
######################################
# Example 10. Unencrypted configuration
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password), encryption: false)
######################################
# Example 11. Configure maximum retry time
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password),
max_transaction_retry_time: 15.seconds)
######################################
# Example 12. Configure trusted certificates
######################################
driver = Neo4j::Driver::GraphDatabase.driver(uri, Neo4j::Driver::AuthTokens.basic(user, password),
trust_strategy: Neo4j::Driver::Config::TrustStrategy.trust_all_certificates)
######################################
# Cypher Workflow
######################################
######################################
# Example 1. Pass bookmarks
######################################
# Create a company node
def add_company(tx, name)
tx.run('CREATE (:Company {name: $name})', name: name)
end
# Create a person node
def add_person(tx, name)
tx.run('CREATE (:Person {name: $name})', name: name)
end
# Create an employment relationship to a pre-existing company node.
# This relies on the person first having been created.
def employ(tx, person, company)
tx.run('MATCH (person:Person {name: $person_name}) ' \
'MATCH (company:Company {name: $company_name}) ' \
'CREATE (person)-[:WORKS_FOR]->(company)',
person_name: person, company_name: company)
end
# Create a friendship between two people.
def make_friends(tx, person1, person2)
tx.run('MATCH (a:Person {name: $person_1}) ' \
'MATCH (b:Person {name: $person_2}) ' \
'MERGE (a)-[:KNOWS]->(b)',
person_1: person1, person_2: person2)
end
# Match and display all friendships.
def print_friends(tx)
result = tx.run('MATCH (a)-[:KNOWS]->(b) RETURN a.name, b.name')
result.each do |record|
puts "#{record['a.name']} knows #{record['b.name']}"
end
end
def add_employ_and_make_friends
# To collect the session bookmarks
saved_bookmarks = []
# Create the first person and employment relationship.
driver.session(Neo4j::Driver::AccessMode::WRITE) do |session1|
session1.write_transaction { |tx| add_company(tx, 'Wayne Enterprises') }
session1.write_transaction { |tx| add_person(tx, 'Alice') }
session1.write_transaction { |tx| employ(tx, 'Alice', 'Wayne Enterprises') }
saved_bookmarks << session1.last_bookmark
end
# Create the second person and employment relationship.
driver.session(Neo4j::Driver::AccessMode::WRITE) do |session2|
session2.write_transaction { |tx| add_company(tx, 'LexCorp') }
session2.write_transaction { |tx| add_person(tx, 'Bob') }
session2.write_transaction { |tx| employ(tx, 'Bob', 'LexCorp') }
saved_bookmarks << session2.last_bookmark
end
# Create a friendship between the two people created above.
driver.session(Neo4j::Driver::AccessMode::WRITE, *saved_bookmarks) do |session3|
session3.write_transaction { |tx| make_friends(tx, 'Alice', 'Bob') }
session3.read_transaction(&method(:print_friends))
end
end
######################################
# Example 3. Read-write transaction
######################################
def add_person(name)
driver.session do |session|
session.write_transaction { |tx| create_person_node(tx, name) }
session.read_transaction { |tx| match_person_node(tx, name) }
end
end
def create_person_node(tx, name)
tx.run('CREATE (a:Person {name: $name})', name: name)
end
def match_person_node(tx, name)
tx.run('MATCH (a:Person {name: $name}) RETURN id(a)', name: name).single.first.to_i
end
######################################
# Example 4. Database selection on session creation
######################################
driver.session(database: 'examples') do |session|
session.run("CREATE (a:Greeting {message: 'Hello, Example-Database'}) RETURN a").consume
end
driver.session(database: 'examples', default_access_mode: :read) do |session|
msg = session.run('MATCH (a:Greeting) RETURN a.message as msg').single[:msg]
puts msg
end
######################################
# Example 5. Map Neo4j types to native language types
######################################
# Neo4j type Ruby type
# null nil
# List Enumerable
# Map Hash (symbolized keys)
# Boolean TrueClass/FalseClass
# Integer Integer (String)*
# Float Float
# String String (Symbol)* (encoding: UTF-8)
# ByteArray String (encoding: BINARY)
# Date Date
# Time Neo4j::Driver::Types::OffsetTime
# LocalTime Neo4j::Driver::Types::LocalTime
# DateTime Time/ActiveSupport::TimeWithZone (DateTime)*
# LocalDateTime Neo4j::Driver::Types::LocalDateTime
# Duration ActiveSupport::Duration
# Point Neo4j::Driver::Types::Point
# Node Neo4j::Driver::Types::Node
# Relationship Neo4j::Driver::Types::Relationship
# Path Neo4j::Driver::Types::Path
# * An Integer smaller than -2 ** 63 or larger than 2 ** 63 will always be implicitly converted to String
# * A Symbol passed as a parameter will always be implicitly converted to String. All Strings other then BINARY encoded when stored in neo4j are converte to UTF-8
# * A ruby DateTime passed as a parameter will always be implicitly converted to Time
######################################
# Session API - Simple Sessions
# Transaction function
######################################
def add_person(name)
driver.session do |session|
session.write_transaction { |tx| create_person_node(tx, name) }
end
end
def create_person_node(tx, name)
tx.run('CREATE (a:Person {name: $name})', name: name)
end
######################################
# Session API - Simple Session
# Auto-commit transaction
######################################
def add_person(name)
driver.session do |session|
session.run('CREATE (a:Person {name: $name})', name: name)
end
end
######################################
# Session API - Simple Session
# Consuming the stream
######################################
def people
driver.session do |session|
session.read_transaction(&method(:match_person_nodes))
end
end
def match_person_nodes(tx)
tx.run('MATCH (a:Person) RETURN a.name ORDER BY a.name').map(&:first)
end
######################################
# Session API - Simple Session
# Retain results for further processing
######################################
def add_employees(company_name)
driver.session do |session|
persons = session.read_transaction(&method(:match_person_nodes))
persons.sum do |person|
session.writeTransaction do |tx|
tx.run('MATCH (emp:Person {name: $person_name}) ' \
'MERGE (com:Company {name: $company_name}) ' \
'MERGE (emp)-[:WORKS_FOR]->(com)',
person_name: person[:name], company_name: company_name)
1
end
end
end
end
def match_person_nodes(tx)
tx.run('MATCH (a:Person) RETURN a.name AS name').to_a
end
######################################
# Session API - Transaction configuration
# Transaction Timeout
######################################
def add_person(name)
driver.session do |session|
session.write_transaction(max_transaction_retry_time: 5.seconds) { |tx| create_person_node(tx, name) }
end
end
def create_person_node(tx, name)
tx.run('CREATE (a:Person {name: $name})', name: name)
end
######################################
# Example 13. Service unavailable
######################################
def add_item
driver.session do |session|
session.write_transaction do |tx|
tx.run('CREATE (a:Item)')
true
end
rescue Neo4j::Driver::Exceptions::ServiceUnavailableException
false
end
end
######################################
# Example 3.1. Session
######################################
def add_person(name)
driver.session do |session|
session.write_transaction do |tx|
tx.run('CREATE (a:Person {name: $name})', name: name)
end
end
end
######################################
# 3.2.3. Explicit transactions
######################################
def add_person(name)
driver.session(Neo4j::Driver::AccessMode::WRITE) do |session|
tx = session.begin_transaction
tx.run('CREATE (a:Person {name: $name})', name: name)
tx.commit
ensure
tx&.close
end
end