After establishing the connection, you are ready to send requests from the application to read and write the database with GQL (Graph Query Language) or UQL (Ultipa Query Language).
Methods
If you are familiar with GQL or UQL, you can send the read or write queries using the gql() or uql() method. See GQL Execution or UQL Execution for details.
The driver also provides the following dedicated methods for key database operations:
- Graphset Management
- Schema and Property Management
- Data Insertion and Deletion
- Query Acceleration
- Algorithm Management
- Downloads and Exports
- Process and Task Management
- Access Management
- Server Statistics
Request Configuration
Reading requests are optionally configured using the RequestConfig class, while writing requests use the InsertRequestConfig class.
RequestConfig
The RequestConfig class has the following parameters:
Parameter |
Type |
Default |
Description |
|---|---|---|---|
graph |
str | / | Name of the graph to use. If not specified, the graph defined in UltipaConfig.defaultGraph will be used. |
timeout |
int | / | Request timeout threshold (in second). |
host |
str | / | Specifies a host in a database cluster to execute the request. |
thread |
int | / | Number of threads, used only for UQL requests. |
timezone |
str | / | Name of the timezone, e.g., Europe/Paris. Defaults to the local timezone if not specified. |
timezoneOffset |
int | / | The offset (in second) from UTC. When both timezone and timezoneOffset are provided, timezoneOffset takes precedence. |
InsertRequestConfig
The InsertRequestConfig class includes all parameters from the RequestConfig class, along with the following:
Parameter |
Type |
Default |
Description |
|---|---|---|---|
insertType |
Ultipa.InsertType |
NORMAL |
Required. The insertion mode. Supports NORMAL, UPSERT, and OVERWRITE. |
silent |
bool | True | Required. Whether to return the inserted or deleted data. Sets to Ture to not return, and False to return. |