Statement->Query

Author: technige

README.md

@@ -173,7 +173,7 @@ var rxSession = driver.rxSession({
 })
 ```
 
-### Executing Statements
+### Executing Queries
 
 #### Consuming Records with Streaming API
 

src/internal/util.js

@@ -31,7 +31,7 @@ function isEmptyObjectOrNull (obj) {
     return false
   }
 
-  for (let prop in obj) {
+  for (const prop in obj) {
     if (obj.hasOwnProperty(prop)) {
       return false
     }
@@ -51,7 +51,7 @@ function isObject (obj) {
  * @return {{query: string, params: object}} the normalized query with parameters.
  * @throws TypeError when either given query or parameters are invalid.
  */
-function validateStatementAndParameters (statement, parameters) {
+function validateQueryAndParameters (statement, parameters) {
   let query = statement
   let params = parameters || {}
 
@@ -60,7 +60,7 @@ function validateStatementAndParameters (statement, parameters) {
     params = statement.parameters || {}
   }
 
-  assertCypherStatement(query)
+  assertCypherQuery(query)
   assertQueryParameters(params)
 
   return { query, params }
@@ -122,7 +122,7 @@ function assertValidDate (obj, objName) {
   return obj
 }
 
-function assertCypherStatement (obj) {
+function assertCypherQuery (obj) {
   assertString(obj, 'Cypher statement')
   if (obj.trim().length === 0) {
     throw new TypeError(
@@ -154,7 +154,7 @@ export {
   assertNumber,
   assertNumberOrInteger,
   assertValidDate,
-  validateStatementAndParameters,
+  validateQueryAndParameters,
   ENCRYPTION_ON,
   ENCRYPTION_OFF
 }

src/result-summary.js

@@ -26,39 +26,39 @@ import { isInt } from './integer'
 class ResultSummary {
   /**
    * @constructor
-   * @param {string} statement - The statement this summary is for
-   * @param {Object} parameters - Parameters for the statement
-   * @param {Object} metadata - Statement metadata
+   * @param {string} query - The query this summary is for
+   * @param {Object} parameters - Parameters for the query
+   * @param {Object} metadata - Query metadata
    */
-  constructor (statement, parameters, metadata) {
+  constructor (query, parameters, metadata) {
     /**
-     * The statement and parameters this summary is for.
+     * The query and parameters this summary is for.
      * @type {{text: string, parameters: Object}}
      * @public
      */
-    this.statement = { text: statement, parameters }
+    this.statement = { text: query, parameters }
 
     /**
-     * The type of statement executed. Can be "r" for read-only statement, "rw" for read-write statement,
-     * "w" for write-only statement and "s" for schema-write statement.
-     * String constants are available in {@link statementType} object.
+     * The type of query executed. Can be "r" for read-only query, "rw" for read-write query,
+     * "w" for write-only query and "s" for schema-write query.
+     * String constants are available in {@link queryType} object.
      * @type {string}
      * @public
      */
-    this.statementType = metadata.type
+    this.queryType = metadata.type
 
     /**
-     * Counters for operations the statement triggered.
-     * @type {StatementStatistics}
+     * Counters for operations the query triggered.
+     * @type {QueryStatistics}
      * @public
      */
-    this.counters = new StatementStatistics(metadata.stats || {})
+    this.counters = new QueryStatistics(metadata.stats || {})
     // for backwards compatibility, remove in future version
     this.updateStatistics = this.counters
 
     /**
-     * This describes how the database will execute the statement.
-     * Statement plan for the executed statement if available, otherwise undefined.
+     * This describes how the database will execute the query.
+     * Query plan for the executed query if available, otherwise undefined.
      * Will only be populated for queries that start with "EXPLAIN".
      * @type {Plan}
      */
@@ -68,8 +68,8 @@ class ResultSummary {
         : false
 
     /**
-     * This describes how the database did execute your statement. This will contain detailed information about what
-     * each step of the plan did. Profiled statement plan for the executed statement if available, otherwise undefined.
+     * This describes how the database did execute your query. This will contain detailed information about what
+     * each step of the plan did. Profiled query plan for the executed query if available, otherwise undefined.
      * Will only be populated for queries that start with "PROFILE".
      * @type {ProfiledPlan}
      * @public
@@ -198,7 +198,7 @@ class ProfiledPlan {
  * Get statistical information for a {@link Result}.
  * @access public
  */
-class StatementStatistics {
+class QueryStatistics {
   /**
    * Structurize the statistics
    * @constructor

src/session-rx.js

@@ -46,18 +46,16 @@ export default class RxSession {
    * transaction configuration that applies to the underlying auto-commit transaction.
    *
    * @public
-   * @param {string} statement - Statement to be executed.
-   * @param {Object} parameters - Parameter values to use in statement execution.
+   * @param {string} query - Query to be executed.
+   * @param {Object} parameters - Parameter values to use in query execution.
    * @param {TransactionConfig} transactionConfig - Configuration for the new auto-commit transaction.
    * @returns {RxResult} - A reactive result
    */
-  run (statement, parameters, transactionConfig) {
+  run (query, parameters, transactionConfig) {
     return new RxResult(
       new Observable(observer => {
         try {
-          observer.next(
-            this._session.run(statement, parameters, transactionConfig)
-          )
+          observer.next(this._session.run(query, parameters, transactionConfig))
           observer.complete()
         } catch (err) {
           observer.error(err)

src/session.js

@@ -23,7 +23,7 @@ import {
 import Result from './result'
 import Transaction from './transaction'
 import { newError } from './error'
-import { validateStatementAndParameters } from './internal/util'
+import { validateQueryAndParameters } from './internal/util'
 import ConnectionHolder from './internal/connection-holder'
 import Driver from './driver'
 import { ACCESS_MODE_READ, ACCESS_MODE_WRITE } from './internal/constants'
@@ -89,22 +89,22 @@ class Session {
    * or with the statement and parameters as separate arguments.
    *
    * @public
-   * @param {mixed} statement - Cypher statement to execute
+   * @param {mixed} query - Cypher statement to execute
    * @param {Object} parameters - Map with parameters to use in statement
    * @param {TransactionConfig} [transactionConfig] - configuration for the new auto-commit transaction.
    * @return {Result} - New Result
    */
-  run (statement, parameters, transactionConfig) {
-    const { query, params } = validateStatementAndParameters(
-      statement,
+  run (query, parameters, transactionConfig) {
+    const { validatedQuery, params } = validateQueryAndParameters(
+      query,
       parameters
     )
     const autoCommitTxConfig = transactionConfig
       ? new TxConfig(transactionConfig)
       : TxConfig.empty()
 
-    return this._run(query, params, connection =>
-      connection.protocol().run(query, params, {
+    return this._run(validatedQuery, params, connection =>
+      connection.protocol().run(validatedQuery, params, {
         bookmark: this._lastBookmark,
         txConfig: autoCommitTxConfig,
         mode: this._mode,
@@ -116,7 +116,7 @@ class Session {
     )
   }
 
-  _run (statement, parameters, customRunner) {
+  _run (query, parameters, customRunner) {
     const connectionHolder = this._connectionHolderWithMode(this._mode)
 
     let observerPromise
@@ -135,14 +135,14 @@ class Session {
       observerPromise = Promise.resolve(
         new FailedObserver({
           error: newError(
-            'Statements cannot be run directly on a ' +
+            'Queries cannot be run directly on a ' +
               'session with an open transaction; either run from within the ' +
               'transaction or use a different session.'
           )
         })
       )
     }
-    return new Result(observerPromise, statement, parameters, connectionHolder)
+    return new Result(observerPromise, query, parameters, connectionHolder)
   }
 
   /**

src/transaction-rx.js

@@ -34,19 +34,19 @@ export default class RxTransaction {
   }
 
   /**
-   * Creates a reactive result that will execute the statement in this transaction, with the provided parameters.
+   * Creates a reactive result that will execute the query in this transaction, with the provided parameters.
    *
    * @public
-   * @param {string} statement - Statement to be executed.
-   * @param {Object} parameters - Parameter values to use in statement execution.
+   * @param {string} query - Query to be executed.
+   * @param {Object} parameters - Parameter values to use in query execution.
    * @returns {RxResult} - A reactive result
    */
 
-  run (statement, parameters) {
+  run (query, parameters) {
     return new RxResult(
       new Observable(observer => {
         try {
-          observer.next(this._txc.run(statement, parameters))
+          observer.next(this._txc.run(query, parameters))
           observer.complete()
         } catch (err) {
           observer.error(err)
@@ -75,7 +75,7 @@ export default class RxTransaction {
   }
 
   /**
-   *  Rollbacks the transaction.
+   *  Rolls back the transaction.
    *
    * @public
    * @returns {Observable} - An empty observable

src/transaction.js

@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 import Result from './result'
-import { validateStatementAndParameters } from './internal/util'
+import { validateQueryAndParameters } from './internal/util'
 import ConnectionHolder, {
   EMPTY_CONNECTION_HOLDER
 } from './internal/connection-holder'
@@ -82,10 +82,7 @@ class Transaction {
    * @return {Result} New Result
    */
   run (statement, parameters) {
-    const { query, params } = validateStatementAndParameters(
-      statement,
-      parameters
-    )
+    const { query, params } = validateQueryAndParameters(statement, parameters)
 
     var result = this._state.run(query, params, {
       connectionHolder: this._connectionHolder,

test/internal/fake-connection.js

@@ -38,7 +38,7 @@ export default class FakeConnection extends Connection {
 
     this.resetInvoked = 0
     this.releaseInvoked = 0
-    this.seenStatements = []
+    this.seenQueries = []
     this.seenParameters = []
     this.seenProtocolOptions = []
     this._server = {}
@@ -72,7 +72,7 @@ export default class FakeConnection extends Connection {
     // return fake protocol object that simply records seen statements and parameters
     return {
       run: (statement, parameters, protocolOptions) => {
-        this.seenStatements.push(statement)
+        this.seenQueries.push(statement)
         this.seenParameters.push(parameters)
         this.seenProtocolOptions.push(protocolOptions)
       }

test/internal/routing-util.test.js

@@ -101,7 +101,7 @@ describe('#unit RoutingUtil', () => {
     const session = FakeSession.withFakeConnection(connection)
 
     callRoutingProcedure(session, '', {}).then(() => {
-      expect(connection.seenStatements).toEqual([
+      expect(connection.seenQueries).toEqual([
         'CALL dbms.cluster.routing.getRoutingTable($context)'
       ])
       expect(connection.seenParameters).toEqual([{ context: {} }])
@@ -115,7 +115,7 @@ describe('#unit RoutingUtil', () => {
 
     callRoutingProcedure(session, '', { key1: 'value1', key2: 'value2' }).then(
       () => {
-        expect(connection.seenStatements).toEqual([
+        expect(connection.seenQueries).toEqual([
           'CALL dbms.cluster.routing.getRoutingTable($context)'
         ])
         expect(connection.seenParameters).toEqual([
@@ -131,7 +131,7 @@ describe('#unit RoutingUtil', () => {
     const session = FakeSession.withFakeConnection(connection)
 
     callRoutingProcedure(session, '', {}).then(() => {
-      expect(connection.seenStatements).toEqual([
+      expect(connection.seenQueries).toEqual([
         'CALL dbms.cluster.routing.getRoutingTable($context)'
       ])
       expect(connection.seenParameters).toEqual([{ context: {} }])
@@ -144,7 +144,7 @@ describe('#unit RoutingUtil', () => {
     const session = FakeSession.withFakeConnection(connection)
 
     callRoutingProcedure(session, '', { key1: 'foo', key2: 'bar' }).then(() => {
-      expect(connection.seenStatements).toEqual([
+      expect(connection.seenQueries).toEqual([
         'CALL dbms.cluster.routing.getRoutingTable($context)'
       ])
       expect(connection.seenParameters).toEqual([
@@ -181,7 +181,7 @@ describe('#unit RoutingUtil', () => {
 
       await callRoutingProcedure(session, '', {})
 
-      expect(connection.seenStatements).toEqual([
+      expect(connection.seenQueries).toEqual([
         'CALL dbms.routing.getRoutingTable($context, $database)'
       ])
       expect(connection.seenParameters).toEqual([
@@ -208,7 +208,7 @@ describe('#unit RoutingUtil', () => {
 
       await callRoutingProcedure(session, '', {})
 
-      expect(connection.seenStatements).toEqual([
+      expect(connection.seenQueries).toEqual([
         'CALL dbms.routing.getRoutingTable($context, $database)'
       ])
       expect(connection.seenParameters).toEqual([
@@ -234,7 +234,7 @@ describe('#unit RoutingUtil', () => {
 
       await callRoutingProcedure(session, '', {})
 
-      expect(connection.seenStatements).toEqual([
+      expect(connection.seenQueries).toEqual([
         'CALL dbms.routing.getRoutingTable($context, $database)'
       ])
       expect(connection.seenParameters).toEqual([
@@ -407,7 +407,7 @@ describe('#unit RoutingUtil', () => {
     const session = FakeSession.withFakeConnection(connection)
 
     callRoutingProcedure(session, database, context).then(() => {
-      expect(connection.seenStatements).toEqual([
+      expect(connection.seenQueries).toEqual([
         'CALL dbms.routing.getRoutingTable($context, $database)'
       ])
       expect(connection.seenParameters).toEqual([
@@ -523,7 +523,7 @@ describe('#unit RoutingUtil', () => {
       return new FakeSession(null, connection)
     }
 
-    _run (ignoreStatement, ignoreParameters, statementRunner) {
+    _run (ignoreQuery, ignoreParameters, statementRunner) {
       if (this._runResponse) {
         return this._runResponse
       }