Package jakarta.nosql.column
Interface ColumnQuery
-
- All Known Subinterfaces:
ColumnQueryPagination
public interface ColumnQuery
Class that contains information to do a select toColumnEntity
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ColumnQuery.ColumnFrom
The ColumnFrom Querystatic interface
ColumnQuery.ColumnLimit
The Column Order whose define the the maximum number of results to retrieve.static interface
ColumnQuery.ColumnNameCondition
The base to name conditionstatic interface
ColumnQuery.ColumnNameOrder
The Column name order a querystatic interface
ColumnQuery.ColumnNotCondition
The column not conditionstatic interface
ColumnQuery.ColumnOrder
The definition to eitherSortType
static interface
ColumnQuery.ColumnQueryBuild
The last step to the build ofColumnQuery
.static interface
ColumnQuery.ColumnSelect
The initial element in the Column querystatic interface
ColumnQuery.ColumnSelectProvider
A provider class ofColumnQuery.ColumnSelect
static interface
ColumnQuery.ColumnSkip
The Column Order whose define the position of the first result to retrieve.static interface
ColumnQuery.ColumnWhere
The Column Where whose define the condition in the query.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getColumnFamily()
The column family nameList<String>
getColumns()
Returns the columns to returns in that query if empty will return all elements in the query.Optional<ColumnCondition>
getCondition()
The conditions that contains in thisColumnQuery
If empty,Optional.empty()
is true, the implementation might either return an unsupported exception or returns same elements in the database.long
getLimit()
long
getSkip()
List<Sort>
getSorts()
The sorts that contains in thisColumnQuery
The implementation might ignore this option.static ColumnQuery.ColumnSelect
select()
Creates a query to Columnstatic ColumnQuery.ColumnSelect
select(String... columns)
Creates a query to Column
-
-
-
Method Detail
-
getLimit
long getLimit()
- Returns:
- The maximum number of results the select object was set to retrieve. The implementation might ignore this option.
-
getSkip
long getSkip()
- Returns:
- The position of the first result the select object was set to retrieve. The implementation might ignore this option.
-
getColumnFamily
String getColumnFamily()
The column family name- Returns:
- the column family name
-
getCondition
Optional<ColumnCondition> getCondition()
The conditions that contains in thisColumnQuery
If empty,Optional.empty()
is true, the implementation might either return an unsupported exception or returns same elements in the database.- Returns:
- the conditions
-
getColumns
List<String> getColumns()
Returns the columns to returns in that query if empty will return all elements in the query. The implementation might ignore this option.- Returns:
- the columns
-
getSorts
List<Sort> getSorts()
The sorts that contains in thisColumnQuery
The implementation might ignore this option.- Returns:
- the sorts
-
select
static ColumnQuery.ColumnSelect select(String... columns)
Creates a query to Column- Parameters:
columns
- - The column fields to query, optional.- Returns:
- a new
ColumnQuery.ColumnSelect
instance - Throws:
NullPointerException
- when there is a null element
-
select
static ColumnQuery.ColumnSelect select()
Creates a query to Column- Returns:
- a new
ColumnQuery.ColumnSelect
instance - Throws:
NullPointerException
- when there is a null element
-
-