Package org.zvec.binding

Class IteratorOptions

java.lang.Object

org.zvec.binding.IteratorOptions

All Implemented Interfaces:

AutoCloseable

public class IteratorOptions
extends Object
implements AutoCloseable

Options for Collection.createIterator(IteratorOptions) (zvec ≥ v0.7.0).

Defaults: all scalar fields are returned and vectors are included. Pass null to Collection.createIterator(IteratorOptions) to use the C-level defaults without allocating an options object.

Constructor Summary

Constructors

Constructor	Description
IteratorOptions()

Method Summary

Modifier and Type	Method	Description
void	close()
void	destroy()
void	setIncludeVector(boolean include)	Set whether to include vector fields in the returned documents.
void	setOutputFields(String[] fields)	Set the scalar fields to return.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IteratorOptions

public IteratorOptions()

Method Details

setOutputFields

public void setOutputFields(String[] fields)

Set the scalar fields to return.

Parameters:

fields - field names; null returns all fields, an empty array returns only the primary key / system columns

setIncludeVector

public void setIncludeVector(boolean include)

Set whether to include vector fields in the returned documents.

destroy

public void destroy()

close

public void close()

Specified by:

close in interface AutoCloseable