Add examples for features not yet implemented

Author: nsauk

docs/dev_manual_todo_examples.rb

@@ -0,0 +1,179 @@
+######################################
+# Query the database
+######################################
+
+result = driver.execute_query(
+  'MATCH (p:Person {age: $age}) RETURN p.name AS name',
+  nil, # auth_token not specified
+  { database: 'neo4j' }, # config
+  age: 42
+)
+
+# To access records after
+records = result.records
+records.each do |r|
+  puts r
+end
+
+# Summary information
+summary = result.summary
+puts "The query #{summary.query.text} returned #{records.size} records in #{summary.result_available_after} ms."
+
+######################################
+# Write to the database
+######################################
+
+# Create two nodes and a relationship
+result = driver.execute_query(
+  'CREATE (a:Person {name: $name})
+   CREATE (b:Person {friend: $name})
+   CREATE (a)-[:KNOWS]->(b)',
+  nil,
+  { database: 'neo4j' },
+  name: 'Alice',
+  friend: 'David'
+)
+
+summary = result.summary
+puts "Created #{summary.counters.nodes_created} records in #{summary.result_available_after} ms."
+
+######################################
+# Read from the database
+######################################
+
+# Retrieve all Person nodes who know other Persons
+result = driver.execute_query(
+  'MATCH (p:Person)-[:KNOWS]->(:Person)
+   RETURN p.name AS name',
+  nil,
+  { database: 'neo4j' }
+)
+
+records = result.records
+records.each do |r|
+  puts r
+end
+
+summary = result.summary
+puts "The query #{summary.query} returned #{records.size} records in #{summary.result_available_after} ms."
+
+######################################
+# Update the database
+######################################
+
+# Update node Alice to add an age property
+result = driver.execute_query(
+  'MATCH (p:Person {name: $name})
+   SET p.age = $age',
+  nil,
+  { database: 'neo4j' },
+  name: 'Alice',
+  age: 42
+)
+
+summary = result.summary
+puts "Query updated the database?"
+puts summary.counters.contains_updates?
+
+# Create a relationship :KNOWS between Alice and Bob
+result = driver.execute_query(
+  'MATCH (alice:Person {name: $name})
+   MATCH (bob:Person {name: $friend})
+   CREATE (alice)-[:KNOWS]->(bob)',
+  nil,
+  { database: 'neo4j' },
+  name: 'Alice',
+  friend: 'Bob'
+)
+
+summary = result.summary
+puts 'Query updated the database?'
+puts summary.counters.contains_updates?
+
+######################################
+# Delete from the database
+######################################
+
+# Remove the Alice node and all its relationships
+result = driver.execute_query(
+  'MATCH (p:Person {name: $name})
+   DETACH DELETE p',
+  nil,
+  { database: 'neo4j' },
+  name: 'Alice'
+)
+
+summary = result.summary
+puts "Query updated the database?"
+puts summary.counters.contains_updates?
+
+######################################
+# Summary
+######################################
+
+# Retrieve the execution summary
+result = driver.execute_query(
+  "UNWIND ['Alice', 'Bob'] AS name
+   MERGE (p:Person {name: name})",
+  nil,
+  { database: 'neo4j' }
+)
+
+puts result.summary
+
+# Query counters
+result = driver.execute_query(
+  "MERGE (p:Person {name: $name})
+   MERGE (p)-[:KNOWS]->(:Person {name: $friend})",
+  nil,
+  { database: 'neo4j' },
+  name: 'Mark',
+  friend: 'Bob'
+)
+query_counters = result.summary.counters
+puts query_counters
+
+# Query execution plan
+result = driver.execute_query(
+  'EXPLAIN MATCH (p {name: $name}) RETURN p',
+  nil,
+  { database: 'neo4j' },
+  name: 'Alice'
+)
+query_plan = result.summary.plan.arguments['string-representation']
+puts query_plan
+
+# Notifications with Neo4j status codes
+result = driver.execute_query(
+  "MATCH p=shortestPath((:Person {name: $start})-[*]->(:Person {name: $end}))
+   RETURN p",
+  nil,
+  { database: 'neo4j' },
+  start: 'Alice',
+  end: 'Bob'
+)
+notifications = result.summary.notifications
+puts notifications
+
+# Notifications with GQL status codes
+result = execute_query(
+  "MATCH p=shortestPath((:Person {name: $start})-[*]->(:Person {name: $end}))
+   RETURN p",
+  nil,
+  { database: 'neo4j' },
+  start: 'Alice',
+  end: 'Bob'
+)
+statuses = result.summary.gql_status_objects
+puts statuses
+
+# Filter notifications
+# Allow only WARNING notifications, but not of HINT or GENERIC classifications
+driver = Neo4j::Driver::GraphDatabase.driver(
+  'bolt://localhost:7687',
+  Neo4j::Driver::AuthTokens.basic('neo4j', 'password'),
+  notification_config: {
+    minimum_severity: :warning, # use :off to disable entirely
+    disabled_categories: [:hint, :generic]
+  }
+)