OGraphBatchInsertBasic (OrientDB 2.2.1-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.orient.graph.batch.OGraphBatchInsertBasic

```
public class OGraphBatchInsertBasic
extends Object
```
this is and API for fast batch import of simple graphs, starting from an empty (or non existing) DB. This class allows import of graphs with
- no properties on edges
- no properties on vertices
- Long values for vertex ids
These limitations are intended to have best performance on a very simple use case. If there limitations don't fit your requirements you can rely on other implementations (at the time of writing this they are planned, but not implemented yet) Typical usage: OGraphBatchInsertSimple batch = new OGraphBatchInsertSimple("plocal:your/db", "admin", "admin"); batch.begin(); batch.createEdge(0L, 1L); batch.createEdge(0L, 2L); ... batch.end(); There is no need to create vertices before connecting them: batch.createVertex(0L); batch.createVertex(1L); batch.createEdge(0L, 1L); is equivalent to (but less performing than) batch.createEdge(0L, 1L); batch.createVertex() is needed only if you want to create unconnected vertices.
Since:

2.0 M3

Author:

Luigi Dell'Aquila (l.dellaquila-at-orientechnologies.com)

Constructor Summary

Constructors
Constructor and Description
`OGraphBatchInsertBasic(String iDbURL)` Creates a new batch insert procedure by using admin user.
`OGraphBatchInsertBasic(String iDbURL, String iUserName, String iPassword)` Creates a new batch insert procedure.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`begin()` Creates the database (if it does not exist) and initializes batch operations.
`void`	`createEdge(Long from, Long to)` Creates a new edge between two vertices.
`void`	`createVertex(Long v)` Creates a new vertex
`void`	`end()` Flushes data to db and closes the db.
`int`	`getAverageEdgeNumberPerNode()`
`int`	`getBonsaiThreshold()`
`String`	`getEdgeClass()`
`int`	`getEstimatedEntries()` Returns the estimated number of entries.
`String`	`getIdPropertyName()`
`int`	`getParallel()`
`String`	`getVertexClass()`
`void`	`setAverageEdgeNumberPerNode(int averageEdgeNumberPerNode)` configures the average number of edges per node (for optimization).
`void`	`setBonsaiThreshold(int bonsaiThreshold)` Sets the threshold for passing from emdedded RidBag to SBTreeBonsai implementation, in number of edges (low level optimization).
`void`	`setEdgeClass(String edgeClass)`
`void`	`setEstimatedEntries(int estimatedEntries)` Sets the estimated number of entries, 0 for auto-resize (default).
`void`	`setIdPropertyName(String idPropertyName)`
`void`	`setParallel(int parallel)` sets the number of parallel threads to be used for batch insert
`void`	`setVertexClass(String vertexClass)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OGraphBatchInsertBasic
```
public OGraphBatchInsertBasic(String iDbURL)
```
    Creates a new batch insert procedure by using admin user. It's intended to be used only for a single batch cycle (begin, create..., end)
    
    Parameters:
    
    iDbURL - db connection URL (plocal:/your/db/path)
  - OGraphBatchInsertBasic
```
public OGraphBatchInsertBasic(String iDbURL,
                              String iUserName,
                              String iPassword)
```
    Creates a new batch insert procedure. It's intended to be used only for a single batch cycle (begin, create..., end)
    
    Parameters:
    
    iDbURL - db connection URL (plocal:/your/db/path)
    
    iUserName - db user name (use admin for new db)
    
    iPassword - db password (use admin for new db)
- Method Detail
  - begin
```
public void begin()
```
    Creates the database (if it does not exist) and initializes batch operations. Call this once, before starting to create vertices and edges.
  - end
```
public void end()
```
    Flushes data to db and closes the db. Call this once, after vertices and edges creation.
  - createVertex
```
public void createVertex(Long v)
```
    Creates a new vertex
    
    Parameters:
    
    v - the vertex ID
  - createEdge
```
public void createEdge(Long from,
                       Long to)
```
    Creates a new edge between two vertices. If vertices do not exist, they will be created
    
    Parameters:
    
    from - id of the vertex that is starting point of the edge
    
    to - id of the vertex that is end point of the edge
  - getAverageEdgeNumberPerNode
```
public int getAverageEdgeNumberPerNode()
```
    Returns:
    
    the configured average number of edges per node (optimization parameter, not calculated)
  - setAverageEdgeNumberPerNode
```
public void setAverageEdgeNumberPerNode(int averageEdgeNumberPerNode)
```
    configures the average number of edges per node (for optimization). Use it before calling begin()
    
    Parameters:
    
    averageEdgeNumberPerNode -
  - getIdPropertyName
```
public String getIdPropertyName()
```
    Returns:
    
    the property name where ids are written on vertices
  - setIdPropertyName
```
public void setIdPropertyName(String idPropertyName)
```
    Parameters:
    
    idPropertyName - the property name where ids are written on vertices
  - getEdgeClass
```
public String getEdgeClass()
```
    Returns:
    
    the edge class name (E by default)
  - setEdgeClass
```
public void setEdgeClass(String edgeClass)
```
    Parameters:
    
    edgeClass - the edge class name
  - getVertexClass
```
public String getVertexClass()
```
    Returns:
    
    the vertex class name (V by default)
  - setVertexClass
```
public void setVertexClass(String vertexClass)
```
    Parameters:
    
    vertexClass - the vertex class name
  - getBonsaiThreshold
```
public int getBonsaiThreshold()
```
    Returns:
    
    the threshold for passing from emdedded RidBag to SBTreeBonsai (low level optimization).
  - setBonsaiThreshold
```
public void setBonsaiThreshold(int bonsaiThreshold)
```
    Sets the threshold for passing from emdedded RidBag to SBTreeBonsai implementation, in number of edges (low level optimization). High values speed up writes but slow down reads later. Set -1 (default) to use default database configuration. See OGlobalConfiguration.RID_BAG_EMBEDDED_TO_SBTREEBONSAI_THRESHOLD}
  - getEstimatedEntries
```
public int getEstimatedEntries()
```
    Returns the estimated number of entries. 0 for auto-resize.
  - setEstimatedEntries
```
public void setEstimatedEntries(int estimatedEntries)
```
    Sets the estimated number of entries, 0 for auto-resize (default). This pre-allocate in memory structure avoiding resizing of them at run-time.
  - getParallel
```
public int getParallel()
```
    Returns:
    
    number of parallel threads used for batch import
  - setParallel
```
public void setParallel(int parallel)
```
    sets the number of parallel threads to be used for batch insert
    
    Parameters:
    
    parallel - number of threads (default 4)

Class OGraphBatchInsertBasic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OGraphBatchInsertBasic

OGraphBatchInsertBasic

Method Detail

begin

end

createVertex

createEdge

getAverageEdgeNumberPerNode

setAverageEdgeNumberPerNode

getIdPropertyName

setIdPropertyName

getEdgeClass

setEdgeClass

getVertexClass

setVertexClass

getBonsaiThreshold

setBonsaiThreshold

getEstimatedEntries

setEstimatedEntries

getParallel

setParallel