# OracleLabsParallelGraphAnalyticsPgxRestApi.PGQLProxiesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createFrameFromPgqlResult**](PGQLProxiesApi.md#createFrameFromPgqlResult) | **POST** /core/v1/pgqlProxies/x-proxy-id/toFrame | Create a frame from a PGQL result set
[**createPgqlResultSetProxy**](PGQLProxiesApi.md#createPgqlResultSetProxy) | **POST** /core/v1/pgqlProxies | Create a PGQL result set proxy
[**getPgqlResultProxy**](PGQLProxiesApi.md#getPgqlResultProxy) | **GET** /core/v1/pgqlProxies/x-proxy-id | Get a PGQL result set proxy
[**getResultElements**](PGQLProxiesApi.md#getResultElements) | **GET** /core/v1/pgqlProxies/x-proxy-id/elements | Get PGQL result set elements
[**getResults**](PGQLProxiesApi.md#getResults) | **GET** /core/v1/pgqlProxies/x-proxy-id/results | Get PGQL result set values

<a name="createFrameFromPgqlResult"></a>
# **createFrameFromPgqlResult**
> FrameMetaData createFrameFromPgqlResult(SID, xProxyId)

Create a frame from a PGQL result set

Create a frame from a PGQl result set

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PGQLProxiesApi();
let SID = "SID_example"; // String | session ID
let xProxyId = "xProxyId_example"; // String | the PGQL result set proxy ID

apiInstance.createFrameFromPgqlResult(SID, xProxyId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xProxyId** | **String**| the PGQL result set proxy ID | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="createPgqlResultSetProxy"></a>
# **createPgqlResultSetProxy**
> PgqlResultSetProxy createPgqlResultSetProxy(body, SID)

Create a PGQL result set proxy

Creates a PGQL query result set proxy by ID

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PGQLProxiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreatePgqlResultProxyRequest(); // CreatePgqlResultProxyRequest | Request body containing the result set ID
let SID = "SID_example"; // String | session ID

apiInstance.createPgqlResultSetProxy(body, SID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreatePgqlResultProxyRequest**](CreatePgqlResultProxyRequest.md)| Request body containing the result set ID | 
 **SID** | **String**| session ID | 

### Return type

[**PgqlResultSetProxy**](PgqlResultSetProxy.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="getPgqlResultProxy"></a>
# **getPgqlResultProxy**
> PgqlResultProxyResponse getPgqlResultProxy(SID, xProxyId)

Get a PGQL result set proxy

Get a PGQL query result set proxy by ID

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PGQLProxiesApi();
let SID = "SID_example"; // String | session ID
let xProxyId = "xProxyId_example"; // String | the PGQL result set proxy ID

apiInstance.getPgqlResultProxy(SID, xProxyId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xProxyId** | **String**| the PGQL result set proxy ID | 

### Return type

[**PgqlResultProxyResponse**](PgqlResultProxyResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getResultElements"></a>
# **getResultElements**
> [PgqlResultElement] getResultElements(SID, xProxyId)

Get PGQL result set elements

Get the PGQL result set elements describing the column types of a given result set

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PGQLProxiesApi();
let SID = "SID_example"; // String | session ID
let xProxyId = "xProxyId_example"; // String | the PGQL result set proxy ID

apiInstance.getResultElements(SID, xProxyId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xProxyId** | **String**| the PGQL result set proxy ID | 

### Return type

[**[PgqlResultElement]**](PgqlResultElement.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getResults"></a>
# **getResults**
> getResults(SID, xProxyId, start, size)

Get PGQL result set values

Get PGQL result set values

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.PGQLProxiesApi();
let SID = "SID_example"; // String | session ID
let xProxyId = "xProxyId_example"; // String | the PGQL result set proxy ID
let start = 56; // Number | pagination: 0-index based PGQL result set row number on which value fetching should start
let size = 56; // Number | pagination: how many elements to fetch

apiInstance.getResults(SID, xProxyId, start, size, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xProxyId** | **String**| the PGQL result set proxy ID | 
 **start** | **Number**| pagination: 0-index based PGQL result set row number on which value fetching should start | 
 **size** | **Number**| pagination: how many elements to fetch | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined