OScriptDocumentDatabaseWrapper (OrientDB 2.2.37 API)

java.lang.Object
- com.orientechnologies.orient.core.command.script.OScriptDocumentDatabaseWrapper

```
public class OScriptDocumentDatabaseWrapper
extends Object
```
Document Database wrapper class to use from scripts.

Author:

Luca Garulli (l.garulli--at--orientechnologies.com)

Field Summary

Fields
Modifier and Type Field and Description

protected ODatabaseDocumentTx database

Fields
Modifier and Type	Field and Description
`protected ODatabaseDocumentTx`	`database`

Constructor Summary

Constructors
Constructor and Description

OScriptDocumentDatabaseWrapper(ODatabaseDocumentTx database)

OScriptDocumentDatabaseWrapper(String iURL)

Constructors
Constructor and Description
`OScriptDocumentDatabaseWrapper(ODatabaseDocumentTx database)`
`OScriptDocumentDatabaseWrapper(String iURL)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ODatabase<ORecord>`	`begin()`
`ORecordIteratorClass<ODocument>`	`browseClass(String iClassName)`
`ORecordIteratorClass<ODocument>`	`browseClass(String iClassName, boolean iPolymorphic)`
`ORecordIteratorCluster<ODocument>`	`browseCluster(String iClusterName)`
`void`	`close()`
`Object`	`command(String iText)`
`Object`	`command(String iText, Object... iParameters)`
`ODatabase<ORecord>`	`commit()`
`protected Object[]`	`convertParameters(Object[] iParameters)`
`long`	`countClass(String iClassName)`
`<THISDB extends ODatabase> THISDB`	`create()`
`boolean`	`declareIntent(OIntent iIntent)`
`ODatabaseDocumentTx`	`delete(ODocument iRecord)`
`ODatabase<ORecord>`	`delete(ORID iRid)`
`void`	`drop()`
`boolean`	`dropCluster(int iClusterId, boolean iTruncate)`
`boolean`	`dropCluster(String iClusterName, boolean iTruncate)`
`Object`	`executeCommand(String iText)` To maintain the compatibility with JS API.
`Object`	`executeCommand(String iText, Object... iParameters)` To maintain the compatibility with JS API.
`boolean`	`exists()`
`Object`	`get(ODatabase.ATTRIBUTES iAttribute)`
`int`	`getClusterIdByName(String iClusterName)`
`String`	`getClusterNameById(int iClusterId)`
`Collection<String>`	`getClusterNames()`
`long`	`getClusterRecordSizeById(int iClusterId)`
`long`	`getClusterRecordSizeByName(String iClusterName)`
`int`	`getClusters()`
`int`	`getDefaultClusterId()`
`ODictionary<ORecord>`	`getDictionary()`
`OIndex<?>`	`getIndex(String iName)`
`OMetadata`	`getMetadata()`
`String`	`getName()`
`Iterator<Map.Entry<String,Object>>`	`getProperties()`
`Object`	`getProperty(String iName)`
`<RET extends ORecord> RET`	`getRecord(OIdentifiable iIdentifiable)`
`byte`	`getRecordType()`
`long`	`getSize()`
`ODatabase.STATUS`	`getStatus()`
`OTransaction`	`getTransaction()`
`String`	`getType()`
`String`	`getURL()`
`OSecurityUser`	`getUser()`
`boolean`	`isClosed()`
`boolean`	`isMVCC()`
`boolean`	`isRetainRecords()`
`boolean`	`isValidationEnabled()`
`<RET extends ORecord> RET`	`load(ORecord iRecord)`
`<RET extends ORecord> RET`	`load(ORecord iRecord, String iFetchPlan)`
`<RET extends ORecord> RET`	`load(ORecord iRecord, String iFetchPlan, boolean iIgnoreCache)`
`<RET extends ORecord> RET`	`load(ORID iRecordId)`
`<RET extends ORecord> RET`	`load(ORID iRecordId, String iFetchPlan)`
`<RET extends ORecord> RET`	`load(ORID iRecordId, String iFetchPlan, boolean iIgnoreCache)`
`<RET extends ORecord> RET`	`load(String iRidAsString)`
`ODocument`	`newInstance()`
`ODocument`	`newInstance(String iClassName)`
`<THISDB extends ODatabase> THISDB`	`open(String iUserName, String iUserPassword)`
`OIdentifiable[]`	`query(OSQLQuery iQuery, Object... iParameters)`
`OIdentifiable[]`	`query(String iText)`
`OIdentifiable[]`	`query(String iText, Object... iParameters)`
`void`	`reload()`
`void`	`reload(ORecord iRecord)`
`void`	`reload(ORecord iRecord, String iFetchPlan, boolean iIgnoreCache)`
`ODatabase<ORecord>`	`rollback()`
`ODocument`	`save(Map<String,Object> iObject)`
`ODocument`	`save(ORecord iRecord)`
`ODocument`	`save(ORecord iRecord, ODatabase.OPERATION_MODE iMode, boolean iForceCreate, ORecordCallback<? extends Number> iRecordCreatedCallback, ORecordCallback<Integer> iRecordUpdatedCallback)`
`ODocument`	`save(ORecord iRecord, String iClusterName)`
`ODocument`	`save(ORecord iRecord, String iClusterName, ODatabase.OPERATION_MODE iMode, boolean iForceCreate, ORecordCallback<? extends Number> iRecordCreatedCallback, ORecordCallback<Integer> iRecordUpdatedCallback)`
`ODocument`	`save(String iString)`
`<THISDB extends ODatabase> THISDB`	`set(ODatabase.ATTRIBUTES attribute, Object iValue)`
`ODatabase<?>`	`setDatabaseOwner(ODatabaseInternal<?> iOwner)`
`void`	`setInternal(ODatabase.ATTRIBUTES attribute, Object iValue)`
`<RET extends ODatabase<?>> RET`	`setMVCC(boolean iValue)`
`Object`	`setProperty(String iName, Object iValue)`
`ODatabaseDocument`	`setRetainRecords(boolean iValue)`
`<THISDB extends ODatabase> THISDB`	`setStatus(ODatabase.STATUS iStatus)`
`void`	`setUser(OUser user)`
`<RET extends ODatabaseDocument> RET`	`setValidationEnabled(boolean iValue)`
`void`	`switchUser(String iUserName, String iUserPassword)`

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

Field Detail
- database
```
protected ODatabaseDocumentTx database
```

Constructor Detail

OScriptDocumentDatabaseWrapper

public OScriptDocumentDatabaseWrapper(ODatabaseDocumentTx database)

OScriptDocumentDatabaseWrapper

public OScriptDocumentDatabaseWrapper(String iURL)

Method Detail

switchUser

public void switchUser(String iUserName,
                       String iUserPassword)

query

public OIdentifiable[] query(String iText)

query

public OIdentifiable[] query(String iText,
                             Object... iParameters)

query

public OIdentifiable[] query(OSQLQuery iQuery,
                             Object... iParameters)

executeCommand
```
public Object executeCommand(String iText)
```
To maintain the compatibility with JS API.

executeCommand

public Object executeCommand(String iText,
                             Object... iParameters)

To maintain the compatibility with JS API.

command
```
public Object command(String iText)
```

command

public Object command(String iText,
                      Object... iParameters)

getIndex

public OIndex<?> getIndex(String iName)

exists
```
public boolean exists()
```

newInstance
```
public ODocument newInstance()
```

reload
```
public void reload()
```

newInstance

public ODocument newInstance(String iClassName)

browseClass

public ORecordIteratorClass<ODocument> browseClass(String iClassName)

getStatus
```
public ODatabase.STATUS getStatus()
```

browseClass

public ORecordIteratorClass<ODocument> browseClass(String iClassName,
                                                   boolean iPolymorphic)

setStatus

public <THISDB extends ODatabase> THISDB setStatus(ODatabase.STATUS iStatus)

drop
```
public void drop()
```

getName
```
public String getName()
```

getURL
```
public String getURL()
```

browseCluster

public ORecordIteratorCluster<ODocument> browseCluster(String iClusterName)

isClosed
```
public boolean isClosed()
```

open

public <THISDB extends ODatabase> THISDB open(String iUserName,
                                              String iUserPassword)

save

public ODocument save(Map<String,Object> iObject)

save

public ODocument save(String iString)

save

public ODocument save(ORecord iRecord)

dropCluster

public boolean dropCluster(String iClusterName,
                           boolean iTruncate)

create

public <THISDB extends ODatabase> THISDB create()

dropCluster

public boolean dropCluster(int iClusterId,
                           boolean iTruncate)

close
```
public void close()
```

getClusters
```
public int getClusters()
```

getClusterNames

public Collection<String> getClusterNames()

getTransaction
```
public OTransaction getTransaction()
```

begin
```
public ODatabase<ORecord> begin()
```

getClusterIdByName

public int getClusterIdByName(String iClusterName)

isMVCC
```
public boolean isMVCC()
```

getClusterNameById

public String getClusterNameById(int iClusterId)

setMVCC

public <RET extends ODatabase<?>> RET setMVCC(boolean iValue)

getClusterRecordSizeById

public long getClusterRecordSizeById(int iClusterId)

isValidationEnabled
```
public boolean isValidationEnabled()
```

getClusterRecordSizeByName

public long getClusterRecordSizeByName(String iClusterName)

setValidationEnabled

public <RET extends ODatabaseDocument> RET setValidationEnabled(boolean iValue)

getUser
```
public OSecurityUser getUser()
```

setUser
```
public void setUser(OUser user)
```

save

public ODocument save(ORecord iRecord,
                      ODatabase.OPERATION_MODE iMode,
                      boolean iForceCreate,
                      ORecordCallback<? extends Number> iRecordCreatedCallback,
                      ORecordCallback<Integer> iRecordUpdatedCallback)

getMetadata
```
public OMetadata getMetadata()
```

getDictionary

public ODictionary<ORecord> getDictionary()

getRecordType
```
public byte getRecordType()
```

delete

public ODatabase<ORecord> delete(ORID iRid)

load

public <RET extends ORecord> RET load(ORID iRecordId)

load

public <RET extends ORecord> RET load(ORID iRecordId,
                                      String iFetchPlan)

load

public <RET extends ORecord> RET load(ORID iRecordId,
                                      String iFetchPlan,
                                      boolean iIgnoreCache)

getRecord

public <RET extends ORecord> RET getRecord(OIdentifiable iIdentifiable)

getDefaultClusterId
```
public int getDefaultClusterId()
```

load

public <RET extends ORecord> RET load(String iRidAsString)

load

public <RET extends ORecord> RET load(ORecord iRecord)

declareIntent

public boolean declareIntent(OIntent iIntent)

load

public <RET extends ORecord> RET load(ORecord iRecord,
                                      String iFetchPlan)

load

public <RET extends ORecord> RET load(ORecord iRecord,
                                      String iFetchPlan,
                                      boolean iIgnoreCache)

setDatabaseOwner

public ODatabase<?> setDatabaseOwner(ODatabaseInternal<?> iOwner)

reload
```
public void reload(ORecord iRecord)
```

reload

public void reload(ORecord iRecord,
                   String iFetchPlan,
                   boolean iIgnoreCache)

setProperty

public Object setProperty(String iName,
                          Object iValue)

save

public ODocument save(ORecord iRecord,
                      String iClusterName)

getProperty

public Object getProperty(String iName)

getProperties

public Iterator<Map.Entry<String,Object>> getProperties()

get

public Object get(ODatabase.ATTRIBUTES iAttribute)

set

public <THISDB extends ODatabase> THISDB set(ODatabase.ATTRIBUTES attribute,
                                             Object iValue)

setInternal

public void setInternal(ODatabase.ATTRIBUTES attribute,
                        Object iValue)

isRetainRecords
```
public boolean isRetainRecords()
```

setRetainRecords

public ODatabaseDocument setRetainRecords(boolean iValue)

getSize
```
public long getSize()
```

save

public ODocument save(ORecord iRecord,
                      String iClusterName,
                      ODatabase.OPERATION_MODE iMode,
                      boolean iForceCreate,
                      ORecordCallback<? extends Number> iRecordCreatedCallback,
                      ORecordCallback<Integer> iRecordUpdatedCallback)

delete

public ODatabaseDocumentTx delete(ODocument iRecord)

countClass

public long countClass(String iClassName)

commit
```
public ODatabase<ORecord> commit()
```

rollback
```
public ODatabase<ORecord> rollback()
```

getType
```
public String getType()
```

convertParameters

protected Object[] convertParameters(Object[] iParameters)

Class OScriptDocumentDatabaseWrapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

database

Constructor Detail

OScriptDocumentDatabaseWrapper

OScriptDocumentDatabaseWrapper

Method Detail

switchUser

query

query

query

executeCommand

executeCommand

command

command

getIndex

exists

newInstance

reload

newInstance

browseClass

getStatus

browseClass

setStatus

drop

getName

getURL

browseCluster

isClosed

open

save

save

save

dropCluster

create

dropCluster

close

getClusters

getClusterNames

getTransaction

begin

getClusterIdByName

isMVCC

getClusterNameById

setMVCC

getClusterRecordSizeById

isValidationEnabled

getClusterRecordSizeByName

setValidationEnabled

getUser

setUser

save

getMetadata

getDictionary

getRecordType

delete

load

load

load

getRecord

getDefaultClusterId

load

load

declareIntent

load

load

setDatabaseOwner

reload

reload

setProperty

save

getProperty

getProperties

get

set

setInternal