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

lightdb.traverse

package lightdb.traverse

Members list

Type members

Classlikes

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

Builder for document traversals

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

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EdgeTraversalBuilder[E <: EdgeDocument[E, F, T], F <: Document[F], T <: Document[T]](fromIds: Stream[Id[F]], tx: PrefixScanningTransaction[E, _], maxDepth: Int, edgeFilter: E => Boolean, strategy: TraversalStrategy)

Builder for edge traversals

Builder for edge traversals

Value parameters

fromIds

The stream of document IDs to start the traversal from

maxDepth

The maximum traversal depth

tx

A transaction that supports prefix scanning for the edge type

Attributes

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

Primary entry point for graph traversals

Primary entry point for graph traversals

Attributes

Supertypes
class Object
trait Matchable
class Any
trait TransactionTraversalSupport[Doc <: Document[Doc], Model <: DocumentModel[Doc]]

Extension methods for transactions to support traversal functionality

Extension methods for transactions to support traversal functionality

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait PrefixScanningTransaction[Doc, Model]
Self type
case class TraversalPath[E <: EdgeDocument[E, From, To], From <: Document[From], To <: Document[To]](edges: List[E])

A path in a traversal

A path in a traversal

Value parameters

edges

The edges that make up the path

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait TraversalStrategy

Traversal strategies

Traversal strategies

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BFS
object DFS
object TraversalStrategy

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Inherited classlikes

case class StepFunctionTraversal[N <: Document[N]](startIds: Set[Id[N]], step: Id[N] => Task[Set[Id[N]]], maxDepth: Int)

A traversal that uses a step function to find neighbors This provides compatibility with legacy code that used BFSEngine.withStepFunction

A traversal that uses a step function to find neighbors This provides compatibility with legacy code that used BFSEngine.withStepFunction

Attributes

Inherited from:
GraphTraversal
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Inherited methods

def createEdgeStepFunction[E <: EdgeDocument[LazyRef(...), N, N], N <: Document[LazyRef(...)], M <: DocumentModel[E]](tx: PrefixScanningTransaction[E, M]): Id[N] => Task[Set[Id[N]]]

Create a type-safe step function from an edge type This provides a type-safe way to create step functions for tests

Create a type-safe step function from an edge type This provides a type-safe way to create step functions for tests

Value parameters

tx

The transaction to use

Attributes

Returns

A type-safe step function

Inherited from:
GraphTraversal
def from[D <: Document[LazyRef(...)]](ids: Set[Id[D]]): DocumentTraversalBuilder[D]

Start a traversal from a set of document IDs

Start a traversal from a set of document IDs

Attributes

Inherited from:
GraphTraversal
def from[D <: Document[LazyRef(...)]](id: Id[D]): DocumentTraversalBuilder[D]

Start a traversal from a single document ID

Start a traversal from a single document ID

Attributes

Inherited from:
GraphTraversal
def fromStream[D <: Document[LazyRef(...)]](idStream: Stream[Id[D]]): DocumentTraversalBuilder[D]

Start a traversal from a stream of document IDs

Start a traversal from a stream of document IDs

Attributes

Inherited from:
GraphTraversal
def withStepFunction[N <: Document[LazyRef(...)]](startIds: Set[Id[N]], step: Id[N] => Task[Set[Id[N]]], maxDepth: Int): StepFunctionTraversal[N]

Create a traversal using a step function, for compatibility with legacy code

Create a traversal using a step function, for compatibility with legacy code

Value parameters

maxDepth

The maximum traversal depth

startIds

The set of starting node IDs

step

The step function that returns neighbors for a node

Attributes

Returns

A StepFunctionTraversal instance

Inherited from:
GraphTraversal
Generated with