PHP-183 - Clean up SimpleStatement and ExecutionOption references in docs and tests

* Updated ExecutionOptions.yaml and Session.yaml to move execution option descriptions to a table in Session.execute's method description.
* Cleaned up Session.executeGraph execution options to be in a table in the method description.
* Update ExecutionOptions::__construct refs in Core.yaml to point to Session.execute().

Author: stamhankar999

ext/src/Core.yaml

@@ -25,31 +25,31 @@ Cassandra:
         has been written on the Coordinator. Requests with this consistency level
         are not guranteed to make it to Replica nodes.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_ONE:
       comment: |-
         Consistency level ONE guarantees that data has been written to at least
         one Replica node.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_LOCAL_ONE:
       comment: |-
         Same as `CONSISTENCY_ONE`, but confined to the local data center. This
         consistency level works only with `NetworkTopologyStrategy` replication.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_TWO:
       comment: |-
         Consistency level TWO guarantees that data has been written to at least
         two Replica nodes.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_THREE:
       comment: |-
         Consistency level THREE guarantees that data has been written to at least
         three Replica nodes.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_QUORUM:
       comment: |-
         Consistency level QUORUM guarantees that data has been written to at least
@@ -59,42 +59,43 @@ Cassandra:
         ceiling function and `RF` is the replication factor used. For example,
         for a replication factor of `5`, the majority is `ceil(5 / 2 + 1) = 3`.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_LOCAL_QUORUM:
       comment: |-
         Same as `CONSISTENCY_QUORUM`, but confined to the local data center. This
         consistency level works only with `NetworkTopologyStrategy` replication.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_EACH_QUORUM:
       comment: |-
         Consistency level EACH_QUORUM guarantees that data has been written to at
         least a majority Replica nodes in all datacenters. This consistency level
         works only with `NetworkTopologyStrategy` replication.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_ALL:
       comment: |-
         Consistency level ALL guarantees that data has been written to all
         Replica nodes.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_SERIAL:
       comment: |-
         This is a serial consistency level, it is used in conditional updates,
         e.g. (`CREATE|INSERT ... IF NOT EXISTS`), and should be specified as the
-        `serial_consistency` option of the ExecutionOptions instance.
+        `serial_consistency` execution option when invoking `session.execute`
+        or `session.execute_async`.
 
         Consistency level SERIAL, when set, ensures that a Paxos commit fails if
         any of the replicas is down.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     CONSISTENCY_LOCAL_SERIAL:
       comment: |-
         Same as `CONSISTENCY_SERIAL`, but confined to the local data center. This
         consistency level works only with `NetworkTopologyStrategy` replication.
 
-        @see ExecutionOptions::__construct()
+        @see Session::execute()
     VERIFY_NONE:
       comment: |-
         Perform no verification of nodes when using SSL encryption.

ext/src/DefaultSession.yaml

@@ -39,7 +39,7 @@ DefaultSession:
           type: string
         options:
           comment: '{@inheritDoc}'
-          type: ExecutionOptions
+          type: array|ExecutionOptions|null
       return:
         comment: '{@inheritDoc}'
         type: PreparedStatement
@@ -51,7 +51,7 @@ DefaultSession:
           type: string
         options:
           comment: '{@inheritDoc}'
-          type: ExecutionOptions
+          type: array|ExecutionOptions|null
       return:
         comment: '{@inheritDoc}'
         type: FuturePreparedStatement

ext/src/ExecutionOptions.yaml

@@ -3,6 +3,8 @@ ExecutionOptions:
   comment: |-
     Request execution options.
 
+    @deprecated Use an array of options instead of creating an instance of this class.
+
     @see Session::execute()
     @see Session::executeAsync()
     @see Session::prepare()
@@ -12,15 +14,7 @@ ExecutionOptions:
       comment: |-
         Creates a new options object for execution.
 
-        * array['arguments']          array        An array or positional or named arguments
-        * array['consistency']        int          One of Cassandra::CONSISTENCY_*
-        * array['timeout']            int|null     A number of seconds or null
-        * array['page_size']          int          A number of rows to include in result for paging
-        * array['paging_state_token'] string       A string token use to resume from the state of a previous result set
-        * array['retry_policy']       RetryPolicy  A retry policy that is used to handle server-side failures for this request
-        * array['serial_consistency'] int          Either Cassandra::CONSISTENCY_SERIAL or Cassandra::CONSISTENCY_LOCAL_SERIAL
-        * array['timestamp']          int|string   Either an integer or integer string timestamp that represents the number
-                                                   of microseconds since the epoch.
+        @see Session::execute() for valid execution options
 
         @throws Exception\InvalidArgumentException
       params:

ext/src/Session.yaml

@@ -7,16 +7,28 @@ Session:
     @see Cluster::connectAsync()
   methods:
     execute:
-      comment: |
+      comment: |-
         Execute a query.
 
+        Available execution options:
+        | Option Name        | Option **Type** | Option Details                                                                                           |
+        |--------------------|-----------------|----------------------------------------------------------------------------------------------------------|
+        | arguments          | array           | An array or positional or named arguments                                                                |
+        | consistency        | int             | A consistency constant e.g Dse::CONSISTENCY_ONE, Dse::CONSISTENCY_QUORUM, etc.                           |
+        | timeout            | int             | A number of rows to include in result for paging                                                         |
+        | paging_state_token | string          | A string token use to resume from the state of a previous result set                                     |
+        | retry_policy       | RetryPolicy     | A retry policy that is used to handle server-side failures for this request                              |
+        | serial_consistency | int             | Either Dse::CONSISTENCY_SERIAL or Dse::CONSISTENCY_LOCAL_SERIAL                                          |
+        | timestamp          | int\|string     | Either an integer or integer string timestamp that represents the number of microseconds since the epoch |
+        | execute_as         | string          | User to execute statement as                                                                             |
+
         @throws Exception
       params:
         statement:
           comment: string or statement to be executed.
           type: string|Statement
         options:
-          comment: execution options (optional)
+          comment: Options to control execution of the query.
           type: array|ExecutionOptions|null
       return:
         comment: A collection of rows.
@@ -25,12 +37,14 @@ Session:
       comment: |-
         Execute a query asynchronously. This method returns immediately, but
         the query continues execution in the background.
+
+        @see Session::execute() for valid execution options
       params:
         statement:
           comment: string or statement to be executed.
           type: string|Statement
         options:
-          comment: execution options (optional)
+          comment: Options to control execution of the query.
           type: array|ExecutionOptions|null
       return:
         comment: A future that can be used to retrieve the result.
@@ -40,26 +54,31 @@ Session:
         Prepare a query for execution.
 
         @throws Exception
+
+        @see Session::execute() for valid execution options
       params:
         cql:
           comment: The query to be prepared.
           type: string
         options:
-          comment: Options to control preparing the query.
-          type: ExecutionOptions
+          comment: |
+            Options to control preparing the query.
+          type: array|ExecutionOptions|null
       return:
-        comment: |
-          A prepared statement that can be bound with parameters and executed.
+        comment: A prepared statement that can be bound with parameters and executed.
         type: PreparedStatement
     prepareAsync:
-      comment: Asynchronously prepare a query for execution.
+      comment: |
+        Asynchronously prepare a query for execution.
+
+        @see Session::execute() for valid execution options
       params:
         cql:
           comment: The query to be prepared.
           type: string
         options:
           comment: Options to control preparing the query.
-          type: ExecutionOptions
+          type: array|ExecutionOptions|null
       return:
         comment: A future that can be used to retrieve the prepared statement.
         type: FuturePreparedStatement