Index (Lucene 10.5.0 replicator API)

# Index

B C D E F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## B

bytesToCopy - Variable in class org.apache.lucene.replicator.nrt.CopyOneFile
bytesToString(long) - Static method in class org.apache.lucene.replicator.nrt.Node

## C

cancel(String, Throwable) - Method in class org.apache.lucene.replicator.nrt.CopyJob
cancelReason - Variable in class org.apache.lucene.replicator.nrt.CopyJob
checksum() - Method in record class org.apache.lucene.replicator.nrt.FileMetaData
  Returns the value of the `checksum` record component.
close() - Method in class org.apache.lucene.replicator.nrt.CopyOneFile
close() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
close() - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
commit() - Method in class org.apache.lucene.replicator.nrt.Node
commit() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
commit() - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
completedMergeFiles() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns the value of the `completedMergeFiles` record component.
conflicts(CopyJob) - Method in class org.apache.lucene.replicator.nrt.CopyJob
  Return true if this job is trying to copy any of the same files as the other job
copiedFiles - Variable in class org.apache.lucene.replicator.nrt.CopyJob
CopyJob - Class in org.apache.lucene.replicator.nrt
  Handles copying one set of files, e.g.
CopyJob(String, Map<String, FileMetaData>, ReplicaNode, boolean, CopyJob.OnceDone) - Constructor for class org.apache.lucene.replicator.nrt.CopyJob
CopyJob.OnceDone - Interface in org.apache.lucene.replicator.nrt
  Callback invoked by CopyJob once all files have (finally) finished copying
CopyOneFile - Class in org.apache.lucene.replicator.nrt
  Copies one file from an incoming DataInput to a dest filename in a local Directory
CopyOneFile(CopyOneFile, DataInput) - Constructor for class org.apache.lucene.replicator.nrt.CopyOneFile
  Transfers this file copy to another input, continuing where the first one left off
CopyOneFile(DataInput, ReplicaNode, String, FileMetaData, byte[]) - Constructor for class org.apache.lucene.replicator.nrt.CopyOneFile
CopyState - Record Class in org.apache.lucene.replicator.nrt
  Holds incRef'd file level details for one point-in-time segment infos on the primary node.
CopyState(Map<String, FileMetaData>, long, long, byte[], Set<String>, long, SegmentInfos) - Constructor for record class org.apache.lucene.replicator.nrt.CopyState
  Creates an instance of a `CopyState` record class.
createTempOutput(String, String, IOContext) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
curNRTCopy - Variable in class org.apache.lucene.replicator.nrt.ReplicaNode
  Non-null when we are currently copying files from a new NRT point:
current - Variable in class org.apache.lucene.replicator.nrt.CopyJob

## D

dest - Variable in class org.apache.lucene.replicator.nrt.CopyJob
dir - Variable in class org.apache.lucene.replicator.nrt.Node

## E

equals(Object) - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class org.apache.lucene.replicator.nrt.FileMetaData
  Indicates whether some other object is "equal to" this one.
exc - Variable in class org.apache.lucene.replicator.nrt.CopyJob

## F

FileMetaData - Record Class in org.apache.lucene.replicator.nrt
  Holds metadata details about a single file that we use to confirm two files (one remote, one local) are in fact "identical".
FileMetaData(byte[], byte[], long, long) - Constructor for record class org.apache.lucene.replicator.nrt.FileMetaData
  Creates an instance of a `FileMetaData` record class.
files - Variable in class org.apache.lucene.replicator.nrt.CopyJob
files() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns the value of the `files` record component.
finish() - Method in class org.apache.lucene.replicator.nrt.CopyJob
  Renames all copied (tmp) files to their true file names
finishCopyFile(String) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
finishNRTCopy(CopyJob, long) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
flushAndRefresh() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
  Flush all index operations to disk and opens a new near-real-time reader.
footer() - Method in record class org.apache.lucene.replicator.nrt.FileMetaData
  Returns the value of the `footer` record component.

## G

gen() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns the value of the `gen` record component.
getBytesCopied() - Method in class org.apache.lucene.replicator.nrt.CopyOneFile
getCopyState() - Method in class org.apache.lucene.replicator.nrt.CopyJob
getCopyState() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
  IncRef the current CopyState and return it
getCopyStateVersion() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
getCurrentSearchingVersion() - Method in class org.apache.lucene.replicator.nrt.Node
getDirectory() - Method in class org.apache.lucene.replicator.nrt.Node
  Returns the `Directory` this node is writing to
getFailed() - Method in class org.apache.lucene.replicator.nrt.CopyJob
getFileNames() - Method in class org.apache.lucene.replicator.nrt.CopyJob
  Returns all file names referenced in this copy job
getFileNamesToCopy() - Method in class org.apache.lucene.replicator.nrt.CopyJob
  Returns only those file names (a subset of `CopyJob.getFileNames()`) that need to be copied
getFilesToCopy(Map<String, FileMetaData>) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
  Compares incoming per-file identity (id, checksum, header, footer) versus what we have locally and returns the subset of the incoming files that need copying
getLastCommitVersion() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
getPrimaryGen() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
  Returns the current primary generation, which is incremented each time a new primary is started for this index
getRemoteCloseTimeoutMs() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
getSearcherManager() - Method in class org.apache.lucene.replicator.nrt.Node
  Returns the `ReferenceManager` to use for acquiring and releasing searchers
getTotalBytesCopied() - Method in class org.apache.lucene.replicator.nrt.CopyJob
globalStartNS - Static variable in class org.apache.lucene.replicator.nrt.Node
  Startup time of original test, carefully propagated to all nodes to produce consistent "seconds since start time" in messages

## H

hashCode() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns a hash code value for this object.
hashCode() - Method in record class org.apache.lucene.replicator.nrt.FileMetaData
  Returns a hash code value for this object.
header() - Method in record class org.apache.lucene.replicator.nrt.FileMetaData
  Returns the value of the `header` record component.
highPriority - Variable in class org.apache.lucene.replicator.nrt.CopyJob
  True for an NRT sync, false for pre-copying a newly merged segment

## I

id - Variable in class org.apache.lucene.replicator.nrt.Node
  Compact ordinal for this node
infos() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns the value of the `infos` record component.
infosBytes() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns the value of the `infosBytes` record component.
isClosed() - Method in class org.apache.lucene.replicator.nrt.Node
isClosed() - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
isClosed() - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
isCopying() - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
isVerboseFiles() - Method in class org.apache.lucene.replicator.nrt.Node

## L

lastFileMetaData - Variable in class org.apache.lucene.replicator.nrt.Node
  File metadata for last sync that succeeded; we use this as a cache
lastNRTFiles - Variable in class org.apache.lucene.replicator.nrt.ReplicaNode
  IncRef'd files in the current NRT point:
lastPrimaryGen - Variable in class org.apache.lucene.replicator.nrt.ReplicaNode
  Primary gen last time we successfully replicated:
launch(CopyJob) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
  Runs this job async'd
launchPreCopyMerge(AtomicBoolean, long, Map<String, FileMetaData>) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
length() - Method in record class org.apache.lucene.replicator.nrt.FileMetaData
  Returns the value of the `length` record component.
localStartNS - Static variable in class org.apache.lucene.replicator.nrt.Node
  When this node was started

## M

maybeNewPrimary(long) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
  Called when the primary changed
mergeCopyJobs - Variable in class org.apache.lucene.replicator.nrt.ReplicaNode
  Currently running merge pre-copy jobs
message(String) - Method in class org.apache.lucene.replicator.nrt.Node
metaData - Variable in class org.apache.lucene.replicator.nrt.CopyOneFile
mgr - Variable in class org.apache.lucene.replicator.nrt.Node

## N

name - Variable in class org.apache.lucene.replicator.nrt.CopyOneFile
name() - Method in class org.apache.lucene.replicator.nrt.Node
newCopyJob(String, Map<String, FileMetaData>, Map<String, FileMetaData>, boolean, CopyJob.OnceDone) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
  Start a background copying job, to copy the specified files from the current primary node.
newCopyOneFile(CopyOneFile) - Method in class org.apache.lucene.replicator.nrt.CopyJob
newNRTPoint(long, long) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
  Call this to notify this replica node that a new NRT infos is available on the primary.
Node - Class in org.apache.lucene.replicator.nrt
  Common base class for `PrimaryNode` and `ReplicaNode`.
Node(int, Directory, SearcherFactory, PrintStream) - Constructor for class org.apache.lucene.replicator.nrt.Node
NodeCommunicationException - Exception Class in org.apache.lucene.replicator.nrt
  Should be thrown by subclasses of `PrimaryNode` and `ReplicaNode` if a non-fatal exception occurred while communicating between nodes.
NodeCommunicationException(String, Throwable) - Constructor for exception class org.apache.lucene.replicator.nrt.NodeCommunicationException
nodeMessage(PrintStream, int, String) - Static method in class org.apache.lucene.replicator.nrt.Node
nodeMessage(PrintStream, String) - Static method in class org.apache.lucene.replicator.nrt.Node

## O

onceDone - Variable in class org.apache.lucene.replicator.nrt.CopyJob
ord - Variable in class org.apache.lucene.replicator.nrt.CopyJob
org.apache.lucene.replicator.nrt - package org.apache.lucene.replicator.nrt
  Near-real-time replication framework

## P

preCopyMergedSegmentFiles(SegmentCommitInfo, Map<String, FileMetaData>) - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
  Called when a merge has finished, but before IW switches to the merged segment
PRIMARY_GEN_KEY - Static variable in class org.apache.lucene.replicator.nrt.Node
  Key to store the primary gen in the commit data, which increments every time we promote a new primary, so replicas can detect when the primary they were talking to is changed
primaryGen - Variable in class org.apache.lucene.replicator.nrt.PrimaryNode
primaryGen() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns the value of the `primaryGen` record component.
PrimaryNode - Class in org.apache.lucene.replicator.nrt
  Node that holds an IndexWriter, indexing documents into its local index.
PrimaryNode(IndexWriter, int, long, long, SearcherFactory, PrintStream) - Constructor for class org.apache.lucene.replicator.nrt.PrimaryNode
printStream - Variable in class org.apache.lucene.replicator.nrt.Node
  For debug logging

## R

readLocalFileMetaData(String) - Method in class org.apache.lucene.replicator.nrt.Node
  Opens the specified file, reads its identifying information, including file length, full index header (includes the unique segment ID) and the full footer (includes checksum), and returns the resulting `FileMetaData`.
reason - Variable in class org.apache.lucene.replicator.nrt.CopyJob
releaseCopyState(CopyState) - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
  Called once replica is done (or failed) copying an NRT point
ReplicaNode - Class in org.apache.lucene.replicator.nrt
  Replica node, that pulls index changes from the primary node by copying newly flushed or merged index files.
ReplicaNode(int, Directory, SearcherFactory, PrintStream) - Constructor for class org.apache.lucene.replicator.nrt.ReplicaNode
run(CopyJob) - Method in interface org.apache.lucene.replicator.nrt.CopyJob.OnceDone
runBlocking() - Method in class org.apache.lucene.replicator.nrt.CopyJob
  Use current thread (blocking) to do all copying and then return once done, or throw exception on failure

## S

searcherFactory - Variable in class org.apache.lucene.replicator.nrt.Node
sendNewReplica() - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
  Tell primary we (replica) just started, so primary can tell us to warm any already warming merges.
setRemoteCloseTimeoutMs(int) - Method in class org.apache.lucene.replicator.nrt.PrimaryNode
  Set the number of milliseconds to wait during shutdown for remote replicas to close.
setVerboseFiles(boolean) - Method in class org.apache.lucene.replicator.nrt.Node
start() - Method in class org.apache.lucene.replicator.nrt.CopyJob
  Begin copying files
start(long) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
  Start up this replica, which possibly requires heavy copying of files from the primary node, if we were down for a long time
startCopyFile(String) - Method in class org.apache.lucene.replicator.nrt.ReplicaNode
startNS - Variable in class org.apache.lucene.replicator.nrt.CopyJob

## T

tmpName - Variable in class org.apache.lucene.replicator.nrt.CopyOneFile
toCopy - Variable in class org.apache.lucene.replicator.nrt.CopyJob
toString() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns a string representation of this record class.
toString() - Method in record class org.apache.lucene.replicator.nrt.FileMetaData
  Returns a string representation of this record class.
toString() - Method in class org.apache.lucene.replicator.nrt.Node
totBytes - Variable in class org.apache.lucene.replicator.nrt.CopyJob
totBytesCopied - Variable in class org.apache.lucene.replicator.nrt.CopyJob
transferAndCancel(CopyJob) - Method in class org.apache.lucene.replicator.nrt.CopyJob
  Transfers whatever tmp files were already copied in this previous job and cancels the previous job

## V

version() - Method in record class org.apache.lucene.replicator.nrt.CopyState
  Returns the value of the `version` record component.
VERSION_KEY - Static variable in class org.apache.lucene.replicator.nrt.Node
  Key to store the version in the commit data, which increments every time we open a new NRT reader
visit() - Method in class org.apache.lucene.replicator.nrt.CopyOneFile
  Copy another chunk of bytes, returning true once the copy is done

## W

writer - Variable in class org.apache.lucene.replicator.nrt.PrimaryNode

B C D E F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form