com.datastax.oss.driver.api.core.CqlSession Maven / Gradle / Ivy
/*
* 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.
*/
package com.datastax.oss.driver.api.core;
import com.datastax.dse.driver.api.core.cql.continuous.ContinuousSession;
import com.datastax.dse.driver.api.core.cql.continuous.reactive.ContinuousReactiveSession;
import com.datastax.dse.driver.api.core.cql.reactive.ReactiveSession;
import com.datastax.dse.driver.api.core.graph.GraphSession;
import com.datastax.dse.driver.api.core.graph.reactive.ReactiveGraphSession;
import com.datastax.oss.driver.api.core.cql.AsyncCqlSession;
import com.datastax.oss.driver.api.core.cql.SyncCqlSession;
import com.datastax.oss.driver.api.core.session.Session;
import edu.umd.cs.findbugs.annotations.NonNull;
/**
* The default session type built by the driver.
*
* It provides user-friendly execution methods for:
*
*
* - CQL requests: synchronous, asynchronous or reactive mode;
*
- requests specific to DataStax Enterprise: graph and continuous paging.
*
*
* Client applications can use this interface even if they don't need all the features. In
* particular, it can be used with a regular Apache Cassandra ® cluster, as long as you don't
* call any of the DSE-specific execute methods. If you're in that situation, you might also want to
* exclude certain dependencies from your classpath (see the "Integration" page in the user manual).
*
* Note that the name "CQL session" is no longer really accurate since this interface can now
* execute other request types; but it was preserved for backward compatibility with previous driver
* versions.
*/
public interface CqlSession
extends Session,
SyncCqlSession,
AsyncCqlSession,
ReactiveSession,
ContinuousSession,
GraphSession,
ContinuousReactiveSession,
ReactiveGraphSession {
/**
* Returns a builder to create a new instance.
*
*
Note that this builder is mutable and not thread-safe.
*
* @return {@code CqlSessionBuilder} to create a new instance.
*/
@NonNull
static CqlSessionBuilder builder() {
return new CqlSessionBuilder();
}
}