Aetheria/Assets/Scripts/ServerShared/NIH/RethinkDb.Driver/Ast/ReqlAst.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Newtonsoft.Json.Linq;
using RethinkDb.Driver.Model;
using RethinkDb.Driver.Net;
using RethinkDb.Driver.Proto;
using RethinkDb.Driver.Utils;

namespace RethinkDb.Driver.Ast
{
    /// <summary>
    /// Base class for all reql queries.
    /// </summary>
    public class ReqlAst
    {
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
        protected internal TermType TermType { get; }
        protected internal Arguments Args { get; }
        protected internal OptArgs OptArgs { get; }

        protected internal ReqlAst(TermType termType, Arguments args, OptArgs optargs)
        {
            this.TermType = termType;
            this.Args = args ?? new Arguments();
            this.OptArgs = optargs ?? new OptArgs();
        }

        protected internal virtual object Build()
        {
            // Create a JSON object from the Ast
            JArray list = new JArray();
            list.Add(TermType);
            if( Args.Count > 0 )
            {
                var collect = Args.Select(a => { return a.Build(); });
                list.Add(new JArray(collect));
            }
            else
            {
                list.Add(new JArray());
            }

            if( OptArgs.Count > 0 )
            {
                list.Add(BuildOptarg(this.OptArgs));
            }
            return list;
        }

        protected internal static JObject BuildOptarg(OptArgs opts)
        {
            var dict = opts.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.Build());
            return JObject.FromObject(dict);
        }
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member

        #region DYNAMIC LANGUAGE RUNTIME (DLR) RUNNERS

        /// <summary>
        /// Runs the query on the connection. If you know the response type
        /// of your query, T (SUCCESS_ATOM) or Cursor[T] (SUCCESS_SEQUENCE or SUCCESS_PARTIAL)
        /// it's recommended to use `.RunAtom`, `.RunCursor` or `.RunResult` helpers
        /// as they offer a slight edge in performance since both bypass the 
        /// dynamic language runtime execution engine.
        /// </summary>
        /// <returns>Returns T or Cursor[T]</returns>
        public virtual Task<dynamic> RunAsync<T>(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return conn.RunAsync<T>(this, runOpts, cancelToken);
        }

        /// <summary>
        /// Runs the query on the connection. If you know the response type
        /// of your query, T (SUCCESS_ATOM) or Cursor[T] (SUCCESS_SEQUENCE or SUCCESS_PARTIAL)
        /// it's recommended to use `.RunAtom`, `.RunCursor` or `.RunResult` helpers
        /// as they offer a slight edge in performance since both bypass the 
        /// dynamic language runtime execution engine.
        /// </summary>
        /// <returns>Returns T or Cursor[T]</returns>
        public virtual Task<dynamic> RunAsync<T>(IConnection conn, CancellationToken cancelToken)
        {
            return RunAsync<T>(conn, null, cancelToken);
        }


        /// <summary>
        /// Runs the query on the connection. If you know the response type
        /// of your query, T (SUCCESS_ATOM) or Cursor[T] (SUCCESS_SEQUENCE or SUCCESS_PARTIAL)
        /// it's recommended to use `.RunAtom`, `.RunCursor` or `.RunResult` helpers
        /// as they offer a slight edge in performance since both bypass the 
        /// dynamic language runtime execution engine.
        /// </summary>
        /// <returns>Returns T or Cursor[T]</returns>
        /// /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<dynamic> RunAsync(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return RunAsync<dynamic>(conn, runOpts, cancelToken);
        }

        /// <summary>
        /// Runs the query on the connection. If you know the response type
        /// of your query, T (SUCCESS_ATOM) or Cursor[T] (SUCCESS_SEQUENCE or SUCCESS_PARTIAL)
        /// it's recommended to use `.RunAtom`, `.RunCursor` or `.RunResult` helpers
        /// as they offer a slight edge in performance since both bypass the 
        /// dynamic language runtime execution engine.
        /// </summary>
        /// <returns>Returns T or Cursor[T]</returns>
        /// /// <param name="conn">connection</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<dynamic> RunAsync(IConnection conn, CancellationToken cancelToken)
        {
            return RunAsync(conn, null, cancelToken);
        }


        /// <summary>
        /// Runs the query on the connection. If you know the response type
        /// of your query, T (SUCCESS_ATOM) or Cursor[T] (SUCCESS_SEQUENCE or SUCCESS_PARTIAL)
        /// it's recommended to use `.RunAtom`, `.RunCursor` or `.RunResult` helpers
        /// as they offer a slight edge in performance since both bypass the 
        /// dynamic language runtime execution engine.
        /// </summary>
        /// <returns>Returns T or Cursor[T]</returns>
        public virtual dynamic Run<T>(IConnection conn, object runOpts = null)
        {
            return RunAsync<T>(conn, runOpts).WaitSync();
        }

        /// <summary>
        /// Runs the query on the connection. If you know the response type
        /// of your query, T (SUCCESS_ATOM) or Cursor[T] (SUCCESS_SEQUENCE or SUCCESS_PARTIAL)
        /// it's recommended to use `.RunAtom`, `.RunCursor` or `.RunResult` helpers
        /// as they offer a slight edge in performance since both bypass the 
        /// dynamic language runtime execution engine.
        /// </summary>
        /// <returns>Returns T or Cursor[T]</returns>
        public virtual dynamic Run(IConnection conn, object runOpts = null)
        {
            return Run<dynamic>(conn, runOpts);
        }

        #endregion

        #region RESPONSE TYPED RUNNERS

        /// <summary>
        /// Executes a query with no expected response. Useful for fire-and-forget queries like insert, update.
        /// </summary>
        public void RunNoReply(IConnection conn, object runOpts = null)
        {
            conn.RunNoReply(this, runOpts);
        }

        /// <summary>
        /// Use this method if you're expecting a cursor (SUCCESS_SEQUENCE or SUCCESS_PARTIAL) response
        /// from your query. This method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        /// <returns>A Cursor</returns>
        public virtual Task<Cursor<T>> RunCursorAsync<T>(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return conn.RunCursorAsync<T>(this, runOpts, cancelToken);
        }

        /// <summary>
        /// Use this method if you're expecting a cursor (SUCCESS_SEQUENCE or SUCCESS_PARTIAL) response
        /// from your query. This method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="conn">connection</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        /// <returns>A Cursor</returns>
        public virtual Task<Cursor<T>> RunCursorAsync<T>(IConnection conn, CancellationToken cancelToken)
        {
            return RunCursorAsync<T>(conn, null, cancelToken);
        }

        /// <summary>
        /// Use this method if you're expecting a cursor (SUCCESS_SEQUENCE or SUCCESS_PARTIAL) response
        /// from your query. This method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <returns>A Cursor</returns>
        public virtual Cursor<T> RunCursor<T>(IConnection conn, object runOpts = null)
        {
            return RunCursorAsync<T>(conn, runOpts).WaitSync();
        }

        /// <summary>
        /// Use this method if you're expecting SUCCESS_ATOM response from your query. This
        /// method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<T> RunAtomAsync<T>(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return conn.RunAtomAsync<T>(this, runOpts, cancelToken);
        }

        /// <summary>
        /// Use this method if you're expecting SUCCESS_ATOM response from your query. This
        /// method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<T> RunAtomAsync<T>(IConnection conn, CancellationToken cancelToken)
        {
            return RunAtomAsync<T>(conn, null, cancelToken);
        }

        /// <summary>
        /// Use this method if you're expecting SUCCESS_ATOM response from your query. This
        /// method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        public virtual T RunAtom<T>(IConnection conn, object runOpts = null)
        {
            return RunAtomAsync<T>(conn, runOpts).WaitSync();
        }

        /// <summary>
        /// Use this method if you're expecting SUCCESS_ATOM or SUCCESS_SEQUENCE response from your query. This
        /// method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses. Consider using RunAtom or RunCursor if your
        /// response is either SUCCESS_ATOM or SUCCESS_SEQUENCE respectively. Exercise caution using this method
        /// with large datasets as the server can switch responses from SUCESS_SEQUENCE to SUCCESS_PARTIAL for the
        /// same exact query.  Refer to the online documentation for this run helper.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<T> RunResultAsync<T>(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return conn.RunResultAsync<T>(this, runOpts, cancelToken);
        }

        /// <summary>
        /// Use this method if you're expecting SUCCESS_ATOM or SUCCESS_SEQUENCE response from your query. This
        /// method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses.  Consider using RunAtom or RunCursor if your
        /// response is either SUCCESS_ATOM or SUCCESS_SEQUENCE respectively. Exercise caution using this method
        /// with large datasets as the server can switch responses from SUCESS_SEQUENCE to SUCCESS_PARTIAL for the
        /// same exact query.  Refer to the online documentation for this run helper.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<T> RunResultAsync<T>(IConnection conn, CancellationToken cancelToken)
        {
            return RunResultAsync<T>(conn, null, cancelToken);
        }

        /// <summary>
        /// Use this method if you're expecting SUCCESS_ATOM or SUCCESS_SEQUENCE response from your query. This
        /// method offers a slight edge in performance without the need for the
        /// dynamic language runtime like the run() method uses. Consider using RunAtom or RunCursor if your
        /// response is either SUCCESS_ATOM or SUCCESS_SEQUENCE respectively. Exercise caution using this method
        /// with large datasets as the server can switch responses from SUCESS_SEQUENCE to SUCCESS_PARTIAL for the
        /// same exact query. Refer to the online documentation for this run helper.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        public virtual T RunResult<T>(IConnection conn, object runOpts = null)
        {
            return RunResultAsync<T>(conn, runOpts).WaitSync();
        }

        #endregion

        #region EXTRA RUN HELPERS

        /// <summary>
        /// OBSOLETE: Please use the .RunWriteAsync() method instead.
        /// </summary>
        [Obsolete("The .RunResultAsync() method has been renamed to .RunWriteAsync(). Please use the new method name instead.", error: false)]
        public virtual Task<Result> RunResultAsync(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return RunWriteAsync(conn, runOpts, cancelToken);
        }

        /// <summary>
        /// OBSOLETE: Please use .RunWriteAsync() method instead.
        /// </summary>
        [Obsolete("The .RunResultAsync() method has been renamed to .RunWriteAsync(). Please use the new method name instead.", error: false)]
        public virtual Task<Result> RunResultAsync(IConnection conn, CancellationToken cancelToken)
        {
            return RunWriteAsync(conn, null, cancelToken);
        }

        /// <summary>
        /// OBSOLETE: Please use .RunWrite() method instead.
        /// </summary>
        [Obsolete("The .RunResult() method has been renamed to .RunWrite(). Please use the new method name instead.", error: false)]
        public virtual Result RunResult(IConnection conn, object runOpts = null)
        {
            return RunWriteAsync(conn, runOpts).WaitSync();
        }


        /// <summary>
        /// Helper shortcut for DML type of queries that returns # of inserts, deletes, errors.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<Result> RunWriteAsync(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return conn.RunAtomAsync<Result>(this, runOpts, cancelToken);
        }

        /// <summary>
        /// Helper shortcut for DML type of queries that returns # of inserts, deletes, errors.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<Result> RunWriteAsync(IConnection conn, CancellationToken cancelToken)
        {
            return RunWriteAsync(conn, null, cancelToken);
        }

        /// <summary>
        /// Helper shortcut for DML type of queries that returns # of inserts, deletes, errors.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        public virtual Result RunWrite(IConnection conn, object runOpts = null)
        {
            return RunWriteAsync(conn, runOpts).WaitSync();
        }



        /// <summary>
        /// Runs a query on the server and returns the raw <see cref="Response"/> object in an unsafe way
        /// with minimal client-side processing. The unbridled use of this method can
        /// lead to memory leaks on both the client and server. This method should only
        /// be used in well-understood and advanced scenarios.
        /// </summary>
        /// <param name="conn">The connection object</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<Response> RunUnsafeAsync(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return conn.RunUnsafeAsync(this, runOpts, cancelToken);
        }



        /// <summary>
        /// Helper shortcut for change feeds, use if your query is expecting an infinite changes() stream.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <typeparam name="T">The document type of new/old value</typeparam>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<Cursor<Change<T>>> RunChangesAsync<T>(IConnection conn, object runOpts = null, CancellationToken cancelToken = default)
        {
            return conn.RunCursorAsync<Change<T>>(this, runOpts, cancelToken);
        }

        /// <summary>
        /// Helper shortcut for change feeds, use if your query is expecting an infinite changes() stream.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <typeparam name="T">The document type of new/old value</typeparam>
        /// <param name="conn">connection</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<Cursor<Change<T>>> RunChangesAsync<T>(IConnection conn, CancellationToken cancelToken)
        {
            return RunChangesAsync<T>(conn, null, cancelToken);
        }

        /// <summary>
        /// Helper shortcut for change feeds, use if your query is expecting an infinite changes() stream.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <typeparam name="T">The document type of new/old value</typeparam>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        public virtual Cursor<Change<T>> RunChanges<T>(IConnection conn, object runOpts = null)
        {
            return RunChangesAsync<T>(conn, runOpts).WaitSync();
        }

        #endregion

        /// <summary>
        /// Helper shortcut for grouping queries.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <typeparam name="TKey">The key type of how items are grouped</typeparam>
        /// <typeparam name="TItem">The type of items</typeparam>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual async Task<IEnumerable<GroupedResult<TKey, TItem>>> RunGroupingAsync<TKey, TItem>(IConnection conn, object runOpts = null,
            CancellationToken cancelToken = default)
        {
            var tsk = await RunAtomAsync<GroupedResultSet<TKey, TItem>>(conn, runOpts, cancelToken).ConfigureAwait(false);
            return tsk;
        }

        /// <summary>
        /// Helper shortcut for grouping queries.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <typeparam name="TKey">The key type of how items are grouped</typeparam>
        /// <typeparam name="TItem">The type of items</typeparam>
        /// <param name="conn">connection</param>
        /// <param name="cancelToken">Cancellation token used to stop *waiting* for a query response. The cancellation token does not cancel the query's execution on the server.</param>
        public virtual Task<IEnumerable<GroupedResult<TKey, TItem>>> RunGroupingAsync<TKey, TItem>(IConnection conn, CancellationToken cancelToken)
        {
            return RunGroupingAsync<TKey, TItem>(conn, null, cancelToken);
        }

        /// <summary>
        /// Helper shortcut for grouping queries.
        /// This method bypasses the dynamic language runtime for extra performance.
        /// </summary>
        /// <typeparam name="TKey">The key type of how items are grouped</typeparam>
        /// <typeparam name="TItem">The type of items</typeparam>
        /// <param name="conn">connection</param>
        /// <param name="runOpts">global anonymous type optional arguments</param>
        public virtual IEnumerable<GroupedResult<TKey, TItem>> RunGrouping<TKey, TItem>(IConnection conn, object runOpts = null)
        {
            return RunAtomAsync<GroupedResultSet<TKey, TItem>>(conn, runOpts).WaitSync();
        }
    }
}