jakarta.nosql.column.ColumnPreparedStatement Maven / Gradle / Ivy
/*
* Copyright (c) 2019 Otavio Santana and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.nosql.column;
import jakarta.nosql.NonUniqueResultException;
import java.util.Optional;
import java.util.stream.Stream;
/**
* An object that represents a precompiled Query statement.
*/
public interface ColumnPreparedStatement {
/**
* Binds an argument to a positional parameter.
*
* @param name the parameter name
* @param value the parameter value
* @return the same query instance
* @throws NullPointerException when there is null parameter
*/
ColumnPreparedStatement bind(String name, Object value);
/**
* Executes a query and return the result as {@link Stream}
*
* @return The result stream, if delete it will return an empty stream
*/
Stream getResult();
/**
* Returns the result as a single element otherwise it will return an {@link Optional#empty()}
*
* @return the single result
* @throws NonUniqueResultException when the result has more than one entity
*/
Optional getSingleResult();
}