com.datastax.dse.driver.api.core.graph.reactive.ReactiveGraphSession Maven / Gradle / Ivy

/*
 * Copyright DataStax, Inc.
 *
 * Licensed 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.
 */
package com.datastax.dse.driver.api.core.graph.reactive;

import com.datastax.dse.driver.api.core.graph.GraphStatement;
import com.datastax.dse.driver.internal.core.graph.reactive.ReactiveGraphRequestProcessor;
import com.datastax.oss.driver.api.core.session.Session;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Objects;

/**
 * A {@link Session} that offers utility methods to issue graph queries using reactive-style
 * programming.
 */
public interface ReactiveGraphSession extends Session {

  /**
   * Returns a {@link ReactiveGraphResultSet} that, once subscribed to, executes the given query and
   * emits all the results.
   *
   * See the javadocs of {@link ReactiveGraphResultSet} for important remarks anc caveats
   * regarding the subscription to and consumption of reactive graph result sets.
   *
   * @param statement the statement to execute.
   * @return The {@link ReactiveGraphResultSet} that will publish the returned results.
   * @see ReactiveGraphResultSet
   * @see ReactiveGraphNode
   */
  @NonNull
  default ReactiveGraphResultSet executeReactive(@NonNull GraphStatement statement) {
    return Objects.requireNonNull(
        execute(statement, ReactiveGraphRequestProcessor.REACTIVE_GRAPH_RESULT_SET));
  }
}