lightdb-core
API
Generated with
lightdb-core/lightdb/lightdb.traverse/DocumentTraversalBuilder

DocumentTraversalBuilder

lightdb.traverse.DocumentTraversalBuilder
case class DocumentTraversalBuilder[D <: Document[D]](ids: Stream[Id[D]], maxDepth: Int)

Builder for document traversals

Value parameters

ids

The stream of document IDs to start the traversal from

maxDepth

The maximum depth to traverse. Defaults to Int.MaxValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def documents(tx: Transaction[D, _]): Stream[D]

Get the stream of documents

Get the stream of documents

Value parameters

tx

A transaction for retrieving documents

Attributes

Returns

A stream of documents

def follow[E <: EdgeDocument[LazyRef(...), D, T], T <: Document[LazyRef(...)]](tx: PrefixScanningTransaction[E, _]): EdgeTraversalBuilder[E, D, T]

Follow edges to traverse the graph

Follow edges to traverse the graph

Type parameters

E

The edge document type

T

The target document type

Value parameters

tx

A transaction that supports prefix scanning for the edge type

Attributes

Returns

A builder for edge traversals

def withMaxDepth(depth: Int): DocumentTraversalBuilder[D]

Configure the maximum traversal depth

Configure the maximum traversal depth

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with