com.datastax.dse.driver.api.core.cql.reactive.ReactiveResultSet 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.dse.driver.api.core.cql.reactive;
import com.datastax.oss.driver.api.core.cql.Statement;
import org.reactivestreams.Publisher;
/**
* A {@link Publisher} of {@link ReactiveRow}s returned by a {@link ReactiveSession}.
*
* By default, all implementations returned by the driver are cold, unicast, single-subscriber
* only publishers. In other words, they do not support multiple subscriptions; consider
* caching the results produced by such publishers if you need to consume them by more than one
* downstream subscriber.
*
*
Also, note that reactive result sets may emit items to their subscribers on an internal driver
* IO thread. Subscriber implementors are encouraged to abide by Reactive Streams
* Specification rule 2.2 and avoid performing heavy computations or blocking calls inside
* {@link org.reactivestreams.Subscriber#onNext(Object) onNext} calls, as doing so could slow down
* the driver and impact performance. Instead, they should asynchronously dispatch received signals
* to their processing logic.
*
*
This interface exists mainly to expose useful information about {@linkplain
* #getExecutionInfos() request execution} and {@linkplain #getColumnDefinitions() query metadata}.
* This is particularly convenient for queries that do not return rows; for queries that do return
* rows, it is also possible, and oftentimes easier, to access that same information {@linkplain
* ReactiveRow at row level}.
*
* @see ReactiveSession#executeReactive(String)
* @see ReactiveSession#executeReactive(Statement)
* @see ReactiveRow
*/
public interface ReactiveResultSet extends Publisher, ReactiveQueryMetadata {}