AllRowsReader.Builder (astyanax-recipes 3.8.0 API)

java.lang.Object
- com.netflix.astyanax.recipes.reader.AllRowsReader.Builder<K,C>

Enclosing class:: AllRowsReader<K,C>

public static class AllRowsReader.Builder<K,C>
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

AllRowsReader.Builder(com.netflix.astyanax.Keyspace ks, com.netflix.astyanax.model.ColumnFamily<K,C> columnFamily)

Constructors
Constructor and Description
`AllRowsReader.Builder(com.netflix.astyanax.Keyspace ks, com.netflix.astyanax.model.ColumnFamily<K,C> columnFamily)`

Method Summary

Methods
Modifier and Type	Method and Description
`AllRowsReader<K,C>`	`build()`
`AllRowsReader.Builder<K,C>`	`forEachPage(com.google.common.base.Function<com.netflix.astyanax.model.Rows<K,C>,java.lang.Boolean> rowsFunction)`
`AllRowsReader.Builder<K,C>`	`forEachRow(com.google.common.base.Function<com.netflix.astyanax.model.Row<K,C>,java.lang.Boolean> rowFunction)` Specify the callback function for each row being read.
`AllRowsReader.Builder<K,C>`	`withCheckpointManager(com.netflix.astyanax.query.CheckpointManager checkpointManager)` Use this checkpoint manager to keep track of progress as all rows are being iterated
`AllRowsReader.Builder<K,C>`	`withColumnRange(C startColumn, C endColumn, boolean reversed, int count)` Specify a range of columns to return.
`AllRowsReader.Builder<K,C>`	`withColumnSlice(C... columns)` Specify a non-contiguous set of columns to retrieve.
`AllRowsReader.Builder<K,C>`	`withColumnSlice(java.util.Collection<C> columns)` Specify a non-contiguous set of columns to retrieve.
`AllRowsReader.Builder<K,C>`	`withColumnSlice(com.netflix.astyanax.model.ColumnSlice<C> columns)` Use this when your application caches the column slice.
`AllRowsReader.Builder<K,C>`	`withConcurrencyLevel(int concurrencyLevel)` Split the query into N threads with each thread processing an equal size chunk from the token range.
`AllRowsReader.Builder<K,C>`	`withConsistencyLevel(com.netflix.astyanax.model.ConsistencyLevel consistencyLevel)`
`AllRowsReader.Builder<K,C>`	`withDc(java.lang.String dc)` Specify dc to use when auto determining the token ranges to ensure that only ranges in the current dc are used.
`AllRowsReader.Builder<K,C>`	`withExecutor(java.util.concurrent.ExecutorService executor)` Use the specific executor for executing the tasks.
`AllRowsReader.Builder<K,C>`	`withIncludeEmptyRows(java.lang.Boolean flag)` The default behavior is to exclude empty rows, other than when specifically asking for no columns back.
`AllRowsReader.Builder<K,C>`	`withPageSize(int pageSize)` Maximum number of rows to return for each incremental query to Cassandra.
`AllRowsReader.Builder<K,C>`	`withPartitioner(com.netflix.astyanax.partitioner.Partitioner partitioner)` Partitioner used to determine token ranges and how to break token ranges into sub parts.
`AllRowsReader.Builder<K,C>`	`withRack(java.lang.String rack)` Specify rack to use when auto determining the token ranges to ensure that only ranges in the current rack are used.
`AllRowsReader.Builder<K,C>`	`withRepeatLastToken(boolean repeatLastToken)` If true will repeat the last token in the previous block when calling cassandra.
`AllRowsReader.Builder<K,C>`	`withRetryPolicy(com.netflix.astyanax.retry.RetryPolicy policy)`
`AllRowsReader.Builder<K,C>`	`withTokenRange(java.math.BigInteger startToken, java.math.BigInteger endToken)` Execute the operation on a specific token range, instead of the entire range.
`AllRowsReader.Builder<K,C>`	`withTokenRange(java.lang.String startToken, java.lang.String endToken)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AllRowsReader.Builder
```
public AllRowsReader.Builder(com.netflix.astyanax.Keyspace ks,
                     com.netflix.astyanax.model.ColumnFamily<K,C> columnFamily)
```
- Method Detail
  - withPageSize
```
public AllRowsReader.Builder<K,C> withPageSize(int pageSize)
```
    Maximum number of rows to return for each incremental query to Cassandra. This limit also represents the page size when paginating.
    
    Parameters:
    blockSize -
    
    Returns:
  - withCheckpointManager
```
public AllRowsReader.Builder<K,C> withCheckpointManager(com.netflix.astyanax.query.CheckpointManager checkpointManager)
```
    Use this checkpoint manager to keep track of progress as all rows are being iterated
    
    Parameters:
    manager -
    
    Returns:
  - withRepeatLastToken
```
public AllRowsReader.Builder<K,C> withRepeatLastToken(boolean repeatLastToken)
```
    If true will repeat the last token in the previous block when calling cassandra. This feature is off by default and is used to handle situations where different row keys map to the same token value and they are split on a page boundary. The may not be efficient since it requires the entire row data to be fetched (based on the column slice)
    
    Parameters:
    repeatLastToken -
    
    Returns:
  - withColumnSlice
```
public AllRowsReader.Builder<K,C> withColumnSlice(C... columns)
```
    Specify a non-contiguous set of columns to retrieve.
    
    Parameters:
    columns -
    
    Returns:
  - withColumnSlice
```
public AllRowsReader.Builder<K,C> withColumnSlice(java.util.Collection<C> columns)
```
    Specify a non-contiguous set of columns to retrieve.
    
    Parameters:
    columns -
    
    Returns:
  - withColumnSlice
```
public AllRowsReader.Builder<K,C> withColumnSlice(com.netflix.astyanax.model.ColumnSlice<C> columns)
```
    Use this when your application caches the column slice.
    
    Parameters:
    slice -
    
    Returns:
  - withColumnRange
```
public AllRowsReader.Builder<K,C> withColumnRange(C startColumn,
                                         C endColumn,
                                         boolean reversed,
                                         int count)
```
    Specify a range of columns to return.
    
    Parameters:
    startColumn - First column in the range
    endColumn - Last column in the range
    reversed - True if the order should be reversed. Note that for reversed, startColumn should be greater than endColumn.
    count - Maximum number of columns to return (similar to SQL LIMIT)
    
    Returns:
  - withConcurrencyLevel
```
public AllRowsReader.Builder<K,C> withConcurrencyLevel(int concurrencyLevel)
```
    Split the query into N threads with each thread processing an equal size chunk from the token range. Note that the actual number of threads is still limited by the available threads in the thread pool that was set with the AstyanaxConfiguration.
    
    Parameters:
    numberOfThreads -
    
    Returns:
  - withExecutor
```
public AllRowsReader.Builder<K,C> withExecutor(java.util.concurrent.ExecutorService executor)
```
    Use the specific executor for executing the tasks. Note that this should be used with care when specifying the withConcurrencyLevel. e.g if you have a concurrencyLevel of 10 with a fixed threadpool of size 1 then this effectively negates the point of the concurrencyLevel
    
    Parameters:
    executor -
    
    Returns:
  - withTokenRange
```
public AllRowsReader.Builder<K,C> withTokenRange(java.math.BigInteger startToken,
                                        java.math.BigInteger endToken)
```
    Execute the operation on a specific token range, instead of the entire range. Use this only is combination with setConcurrencyLevel being called otherwise it currently will not have any effect on the query. When using forTokenRange the specified token range will still be split into the number of threads specified by setConcurrencyLevel
    
    Parameters:
    startToken -
    endToken -
    
    Returns:
  - withTokenRange
```
public AllRowsReader.Builder<K,C> withTokenRange(java.lang.String startToken,
                                        java.lang.String endToken)
```
  - withPartitioner
```
public AllRowsReader.Builder<K,C> withPartitioner(com.netflix.astyanax.partitioner.Partitioner partitioner)
```
    Partitioner used to determine token ranges and how to break token ranges into sub parts. The default is BigInteger127Partitioner which is the RandomPartitioner in cassandra.
    
    Parameters:
    partitioner -
    
    Returns:
  - withIncludeEmptyRows
```
public AllRowsReader.Builder<K,C> withIncludeEmptyRows(java.lang.Boolean flag)
```
    The default behavior is to exclude empty rows, other than when specifically asking for no columns back. Setting this to true will result in the row callback function being called for empty rows.
    
    Parameters:
    flag -
    
    Returns:
  - forEachRow
```
public AllRowsReader.Builder<K,C> forEachRow(com.google.common.base.Function<com.netflix.astyanax.model.Row<K,C>,java.lang.Boolean> rowFunction)
```
    Specify the callback function for each row being read. This callback must be implemented in a thread safe manner since it will be called by multiple internal threads.
    
    Parameters:
    rowFunction -
    
    Returns:
  - forEachPage
```
public AllRowsReader.Builder<K,C> forEachPage(com.google.common.base.Function<com.netflix.astyanax.model.Rows<K,C>,java.lang.Boolean> rowsFunction)
```
  - withConsistencyLevel
```
public AllRowsReader.Builder<K,C> withConsistencyLevel(com.netflix.astyanax.model.ConsistencyLevel consistencyLevel)
```
  - withDc
```
public AllRowsReader.Builder<K,C> withDc(java.lang.String dc)
```
    Specify dc to use when auto determining the token ranges to ensure that only ranges in the current dc are used.
    
    Parameters:
    rack -
    
    Returns:
  - withRack
```
public AllRowsReader.Builder<K,C> withRack(java.lang.String rack)
```
    Specify rack to use when auto determining the token ranges to ensure that only ranges in the current rack are used.
    
    Parameters:
    rack -
    
    Returns:
  - withRetryPolicy
```
public AllRowsReader.Builder<K,C> withRetryPolicy(com.netflix.astyanax.retry.RetryPolicy policy)
```
  - build
```
public AllRowsReader<K,C> build()
```

Class AllRowsReader.Builder<K,C>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AllRowsReader.Builder

Method Detail

withPageSize

withCheckpointManager

withRepeatLastToken

withColumnSlice

withColumnSlice

withColumnSlice

withColumnRange

withConcurrencyLevel

withExecutor

withTokenRange

withTokenRange

withPartitioner

withIncludeEmptyRows

forEachRow

forEachPage

withConsistencyLevel

withDc

withRack

withRetryPolicy

build