TransactionBuilder (JanusGraph 0.3.1 API)

All Known Implementing Classes:

StandardTransactionBuilder
```
public interface TransactionBuilder
```
Constructor returned by JanusGraph.buildTransaction() to build a new transaction. The TransactionBuilder allows certain aspects of the resulting transaction to be configured up-front.

Author:

Matthias Broecheler ([email protected])

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TransactionBuilder`	`checkExternalVertexExistence(boolean enabled)` Enables/disables checking whether the vertex with a user provided id indeed exists.
`TransactionBuilder`	`checkInternalVertexExistence(boolean enabled)` Enables/disables checks that verify that each vertex actually exists in the underlying data store when it is retrieved.
`TransactionBuilder`	`commitTime(Instant instant)` Sets the timestamp for this transaction.
`TransactionBuilder`	`consistencyChecks(boolean enabled)` Enables/disables consistency checking and locking for this transaction.
`TransactionBuilder`	`customOption(String k, Object v)` Configures a custom option on this transaction which will be passed through to the storage and indexing backends.
`TransactionBuilder`	`dirtyVertexSize(int size)` Configures the initial size of the map of modified vertices held by this transaction.
`TransactionBuilder`	`disableBatchLoading()` Disables batch loading by ensuring that consistency checks are applied in this transaction.
`TransactionBuilder`	`enableBatchLoading()` Enabling batch loading disables a number of consistency checks inside JanusGraph to speed up the ingestion of data under the assumptions that inconsistencies are resolved prior to loading.
`TransactionBuilder`	`groupName(String name)` Sets the group name for this transaction which provides a way for gathering reporting on multiple transactions into one group.
`TransactionBuilder`	`logIdentifier(String logName)` Name of the log to be used for logging the mutations in this transaction.
`TransactionBuilder`	`readOnly()` Makes the transaction read only.
`TransactionBuilder`	`restrictedPartitions(int[] partitions)` Configures this transaction such that queries against partitioned vertices are restricted to the given partitions.
`JanusGraphTransaction`	`start()` Starts and returns the transaction build by this builder
`TransactionBuilder`	`vertexCacheSize(int size)` Configures the size of the internal caches used in the transaction.

- Method Detail
  - readOnly
```
TransactionBuilder readOnly()
```
    Makes the transaction read only. Any writes will cause an exception. Read-only transactions do not have to maintain certain data structures and can hence be more efficient.
    
    Returns:
    
    Object containing read-only properties set to true
  - enableBatchLoading
```
TransactionBuilder enableBatchLoading()
```
    Enabling batch loading disables a number of consistency checks inside JanusGraph to speed up the ingestion of data under the assumptions that inconsistencies are resolved prior to loading.
    
    Returns:
    
    Object containting properties that will enable batch loading
  - disableBatchLoading
```
TransactionBuilder disableBatchLoading()
```
    Disables batch loading by ensuring that consistency checks are applied in this transaction. This allows an individual transaction to use consistency checks when the graph as a whole is configured to not use them, which is useful when defining schema elements in a graph with batch-loading enabled.
    
    Returns:
    
    Object containting properties that will disable batch loading
  - vertexCacheSize
```
TransactionBuilder vertexCacheSize(int size)
```
    Configures the size of the internal caches used in the transaction.
    
    Parameters:
    
    size - The size of the initial cache for the transaction
    
    Returns:
    
    Object containing the internal cache properties
  - dirtyVertexSize
```
TransactionBuilder dirtyVertexSize(int size)
```
    Configures the initial size of the map of modified vertices held by this transaction. This is a performance hint, not a hard upper bound. The map will grow if the transaction ends up modifying more vertices than expected.
    
    Parameters:
    
    size - The initial size of the transaction's dirty vertex collection
    
    Returns:
    
    Object containing properties that configure inital map size of modified vertices
  - checkInternalVertexExistence
```
TransactionBuilder checkInternalVertexExistence(boolean enabled)
```
    Enables/disables checks that verify that each vertex actually exists in the underlying data store when it is retrieved. This might be useful to address common data degradation issues but has adverse impacts on performance due to repeated existence checks.
    Note, that these checks apply to vertex retrievals inside the query execution engine and not to vertex ids provided by the user.
    
    Parameters:
    
    enabled - Enable or disable the internal vertex existence checks
    
    Returns:
    
    Object with the internal vertex existence check properties
  - checkExternalVertexExistence
```
TransactionBuilder checkExternalVertexExistence(boolean enabled)
```
    Enables/disables checking whether the vertex with a user provided id indeed exists. If the user is absolutely sure that the vertices for the ids provided in this transaction exist in the underlying data store, then disabling the vertex existence check will improve performance because it eliminates a database call. However, if a provided vertex id does not exist in the database and checking is disabled, JanusGraph will assume it exists which can lead to data and query inconsistencies.
    
    Parameters:
    
    enabled - Enable or disable the external vertex existence checks
    
    Returns:
    
    Object with the external vertex existence check properties
  - consistencyChecks
```
TransactionBuilder consistencyChecks(boolean enabled)
```
    Enables/disables consistency checking and locking for this transaction. Disabling consistency checks improves performance but requires that the user ensures consistency at the application level. Use with great care.
    
    Parameters:
    
    enabled - Enable or disable consistency check and locking
    
    Returns:
    
    Object with the consistency check settings
  - commitTime
```
TransactionBuilder commitTime(Instant instant)
```
    Sets the timestamp for this transaction. The transaction will be recorded with this timestamp in those storage backends where the timestamp is recorded.
    
    Parameters:
    
    instant - The instant at which the commit took place
    
    Returns:
    
    Object with the commit time property
  - groupName
```
TransactionBuilder groupName(String name)
```
    Sets the group name for this transaction which provides a way for gathering reporting on multiple transactions into one group. By setting a group one enables Metrics for this transaction, and defines what string should start the transaction's metric names.
    If null, Metrics collection is totally disabled for this transaction.
    If empty, Metrics collection is enabled, but there will be no prefix. Where the default setting would generate metrics names in the form "prefix.x.y.z", this transaction will instead use metric names in the form "x.y.z".
    If nonempty, Metrics collection is enabled and the prefix will be used for all of this transaction's measurements.
    Note: setting this to a non-null value only partially overrides GraphDatabaseConfiguration.BASIC_METRICS = false in the graph database configuration. When Metrics are disabled at the graph level and enabled at the transaction level, storage backend timings and counters will remain disabled.
    The default value is GraphDatabaseConfiguration.METRICS_PREFIX_DEFAULT. Sets the name prefix used for Metrics recorded by this transaction. If metrics is enabled via GraphDatabaseConfiguration.BASIC_METRICS, this string will be prepended to all JanusGraph metric names.
    
    Parameters:
    
    name - Metric name prefix for this transaction
    
    Returns:
    
    Object containing transaction prefix name property
  - logIdentifier
```
TransactionBuilder logIdentifier(String logName)
```
    Name of the log to be used for logging the mutations in this transaction. If no log identifier is set, then this transaction will not be logged.
    
    Parameters:
    
    logName - name of transaction log
    
    Returns:
    
    Object containing log identifier property
  - restrictedPartitions
```
TransactionBuilder restrictedPartitions(int[] partitions)
```
    Configures this transaction such that queries against partitioned vertices are restricted to the given partitions.
    
    Parameters:
    
    partitions - Array of the int identifier of the partitions to be queried
    
    Returns:
    
    Object with restricted partitions
  - customOption
```
TransactionBuilder customOption(String k,
                                Object v)
```
    Configures a custom option on this transaction which will be passed through to the storage and indexing backends.
    
    Parameters:
    
    k - Name of the configuration element.
    
    v - Object containing the custom options to be applied.
    
    Returns:
    
    Object containing the properties in param v
  - start
```
JanusGraphTransaction start()
```
    Starts and returns the transaction build by this builder
    
    Returns:
    
    A new transaction configured according to this builder

Interface TransactionBuilder

Method Summary

Method Detail

readOnly

enableBatchLoading

disableBatchLoading

vertexCacheSize

dirtyVertexSize

checkInternalVertexExistence

checkExternalVertexExistence

consistencyChecks

commitTime

groupName

logIdentifier

restrictedPartitions

customOption

start