gremlin-js/gremlin-javascript/lib/process/transaction.ts

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

import { RemoteConnection, RemoteStrategy } from '../driver/remote-connection.js';
import GremlinLang from './gremlin-lang.js';
import { GraphTraversalSource } from './graph-traversal.js';
import { TraversalStrategies } from './traversal-strategy.js';

/**
 * A controller for a remote transaction that is constructed from <code>g.tx()</code>. Calling <code>begin()</code>
 * on this object will produce a new <code>GraphTraversalSource</code> that is bound to a remote transaction over which
 * multiple traversals may be executed in that context. Calling <code>commit()</code> or <code>rollback()</code> will
 * then close the transaction and thus, the session. This feature only works with transaction enabled graphs.
 */
export class Transaction {
  private _sessionBasedConnection?: RemoteConnection = undefined;

  constructor(private readonly g: GraphTraversalSource) {}

  /**
   * Spawns a <code>GraphTraversalSource</code> that is bound to a remote session which enables a transaction.
   * @returns {GraphTraversalSource}
   */
  begin(): GraphTraversalSource {
    throw new Error ("Transactions are not yet implemented")
  }

  /**
   * @returns {Promise}
   */
  commit(): Promise<void> {
    throw new Error ("Transactions are not yet implemented")
  }

  /**
   * @returns {Promise}
   */
  rollback(): Promise<void> {
    throw new Error ("Transactions are not yet implemented")
  }

  /**
   * Returns true if transaction is open.
   * @returns {Boolean}
   */
  get isOpen(): boolean {
    return this._sessionBasedConnection?.isOpen ?? false;
  }

  /**
   * @returns {Promise}
   */
  async close(): Promise<void> {
    if (this._sessionBasedConnection) {
      this._sessionBasedConnection.close();
    }
  }
}