# OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**addRowsToFrameBuilder**](FramesApi.md#addRowsToFrameBuilder) | **POST** /core/v1/frameBuilders/x-frame-builder-id/rows | Add rows to a frame builder
[**buildFrame**](FramesApi.md#buildFrame) | **POST** /core/v1/frameBuilders/x-frame-builder-id/build | Build a frame from a frame builder
[**createFrameBuilder**](FramesApi.md#createFrameBuilder) | **POST** /core/v1/createFrameBuilder | Create a frame builder
[**deleteFrame**](FramesApi.md#deleteFrame) | **DELETE** /core/v1/frames/x-frame-id | Delete a frame
[**describeFrame**](FramesApi.md#describeFrame) | **POST** /core/v1/describeFrame | Describe a frame
[**destroyFrameBuilder**](FramesApi.md#destroyFrameBuilder) | **DELETE** /core/v1/frameBuilders/x-frame-builder-id | Destroy a frame builder
[**flattenFrame**](FramesApi.md#flattenFrame) | **POST** /core/v1/frames/x-frame-id/flatten | Flatten a frame
[**frameCount**](FramesApi.md#frameCount) | **GET** /core/v1/frames/x-frame-id/count | Retrieve the number of rows in a frame
[**frameHead**](FramesApi.md#frameHead) | **POST** /core/v1/frames/x-frame-id/extractHead | Extract the first rows of a frame
[**frameTail**](FramesApi.md#frameTail) | **POST** /core/v1/frames/x-frame-id/extractTail | Extract the last rows of a frame
[**frameToPgqlResultSet**](FramesApi.md#frameToPgqlResultSet) | **GET** /core/v1/frames/x-frame-id/pgqlResultSet | Convert a frame into a PGQL result set
[**joinFrames**](FramesApi.md#joinFrames) | **POST** /core/v1/frames/join | Joins two frames
[**loadFrame**](FramesApi.md#loadFrame) | **POST** /core/v1/loadFrame | Load a frame
[**printFrame**](FramesApi.md#printFrame) | **POST** /core/v1/frames/x-frame-id/print | Build a textual representation of the frame
[**selectFrame**](FramesApi.md#selectFrame) | **POST** /core/v1/frames/x-frame-id/select | Select frame columns
[**storeFrame**](FramesApi.md#storeFrame) | **POST** /core/v1/frames/x-frame-id/store | Store a frame
[**unionFrames**](FramesApi.md#unionFrames) | **POST** /core/v1/frames/union | Unions a set of frames

<a name="addRowsToFrameBuilder"></a>
# **addRowsToFrameBuilder**
> addRowsToFrameBuilder(body, SID, opts)

Add rows to a frame builder

The PGX server will add rows to a frame builder.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.AddRowsToFrameBuilderRequest(); // AddRowsToFrameBuilderRequest | specifies the location of the graph
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameBuilderId': "xFrameBuilderId_example" // String | 
};
apiInstance.addRowsToFrameBuilder(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**AddRowsToFrameBuilderRequest**](AddRowsToFrameBuilderRequest.md)| specifies the location of the graph | 
 **SID** | **String**| session ID | 
 **xFrameBuilderId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="buildFrame"></a>
# **buildFrame**
> buildFrame(body, SID, opts)

Build a frame from a frame builder

A frame will be built.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.BuildFrameRequest(); // BuildFrameRequest | specifies the location of the graph
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameBuilderId': "xFrameBuilderId_example" // String | 
};
apiInstance.buildFrame(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**BuildFrameRequest**](BuildFrameRequest.md)| specifies the location of the graph | 
 **SID** | **String**| session ID | 
 **xFrameBuilderId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="createFrameBuilder"></a>
# **createFrameBuilder**
> PgxId createFrameBuilder(body, SID)

Create a frame builder

The frame builder will only be server-side.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateFrameBuilderRequest(); // CreateFrameBuilderRequest | specifies the location of the graph
let SID = "SID_example"; // String | session ID

apiInstance.createFrameBuilder(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** | [**CreateFrameBuilderRequest**](CreateFrameBuilderRequest.md)| specifies the location of the graph | 
 **SID** | **String**| session ID | 

### Return type

[**PgxId**](PgxId.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="deleteFrame"></a>
# **deleteFrame**
> deleteFrame(SID, xFrameId, opts)

Delete a frame

Deletes a specific loaded frame in current session

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let SID = "SID_example"; // String | session ID
let xFrameId = "xFrameId_example"; // String | the name of the frame whose result should be deleted
let opts = { 
  'csrfToken': "csrfToken_example" // String | CSRF token
};
apiInstance.deleteFrame(SID, xFrameId, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xFrameId** | **String**| the name of the frame whose result should be deleted | 
 **csrfToken** | **String**| CSRF token | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="describeFrame"></a>
# **describeFrame**
> GraphConfig describeFrame(body, SID)

Describe a frame

The PGX server will create a configuration for the frame from the location you specified, which is part of the DescribeFrameRequest json payload.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.DescribeFrameRequest(); // DescribeFrameRequest | specifies the location of the graph
let SID = "SID_example"; // String | session ID

apiInstance.describeFrame(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** | [**DescribeFrameRequest**](DescribeFrameRequest.md)| specifies the location of the graph | 
 **SID** | **String**| session ID | 

### Return type

[**GraphConfig**](GraphConfig.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="destroyFrameBuilder"></a>
# **destroyFrameBuilder**
> destroyFrameBuilder(SID, opts)

Destroy a frame builder

PgxServer frame builder will be destroyed, including its data.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameBuilderId': "xFrameBuilderId_example" // String | 
};
apiInstance.destroyFrameBuilder(SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xFrameBuilderId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="flattenFrame"></a>
# **flattenFrame**
> FrameMetaData flattenFrame(body, SID, xFrameId)

Flatten a frame

Flattens the vector columns of a frame

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.FlattenFrameRequest(); // FlattenFrameRequest | object that holds information on how to flatten the frame
let SID = "SID_example"; // String | session ID
let xFrameId = "xFrameId_example"; // String | the name of the frame that should be flattened

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**FlattenFrameRequest**](FlattenFrameRequest.md)| object that holds information on how to flatten the frame | 
 **SID** | **String**| session ID | 
 **xFrameId** | **String**| the name of the frame that should be flattened | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="frameCount"></a>
# **frameCount**
> frameCount(SID, opts)

Retrieve the number of rows in a frame

Retrieves the number of rows in a frame

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameId': "xFrameId_example" // String | 
};
apiInstance.frameCount(SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xFrameId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="frameHead"></a>
# **frameHead**
> FrameMetaData frameHead(body, SID, opts)

Extract the first rows of a frame

Retrieves the first rows of a frame

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.FrameExtractionRequest(); // FrameExtractionRequest | object that holds information on how many rows to extract
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameId': "xFrameId_example" // String | 
};
apiInstance.frameHead(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**FrameExtractionRequest**](FrameExtractionRequest.md)| object that holds information on how many rows to extract | 
 **SID** | **String**| session ID | 
 **xFrameId** | **String**|  | [optional] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="frameTail"></a>
# **frameTail**
> FrameMetaData frameTail(body, SID, opts)

Extract the last rows of a frame

Retrieves the last rows of a frame

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.FrameExtractionRequest(); // FrameExtractionRequest | object that holds information on how many rows to extract
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameId': "xFrameId_example" // String | 
};
apiInstance.frameTail(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**FrameExtractionRequest**](FrameExtractionRequest.md)| object that holds information on how many rows to extract | 
 **SID** | **String**| session ID | 
 **xFrameId** | **String**|  | [optional] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="frameToPgqlResultSet"></a>
# **frameToPgqlResultSet**
> PgqlResultSetProxy frameToPgqlResultSet(SID, opts)

Convert a frame into a PGQL result set

Convert a frame into a PGQL result set

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameId': "xFrameId_example" // String | 
};
apiInstance.frameToPgqlResultSet(SID, opts, (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 | 
 **xFrameId** | **String**|  | [optional] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="joinFrames"></a>
# **joinFrames**
> FrameMetaData joinFrames(body, SID)

Joins two frames

Creates a new frame by joining the rows of the two input frames

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.JoinFramesRequest(); // JoinFramesRequest | object that holds information on the frames to join
let SID = "SID_example"; // String | session ID

apiInstance.joinFrames(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** | [**JoinFramesRequest**](JoinFramesRequest.md)| object that holds information on the frames to join | 
 **SID** | **String**| session ID | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="loadFrame"></a>
# **loadFrame**
> FrameMetaData loadFrame(body, SID)

Load a frame

Loads a frame in current session

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.LoadFrameRequest(); // LoadFrameRequest | The request body defines the details to the frame loading request.
let SID = "SID_example"; // String | session ID

apiInstance.loadFrame(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** | [**LoadFrameRequest**](LoadFrameRequest.md)| The request body defines the details to the frame loading request. | 
 **SID** | **String**| session ID | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="printFrame"></a>
# **printFrame**
> printFrame(body, SID, opts)

Build a textual representation of the frame

Builds a textual representation of the frame with the specified number of rows and offset

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramePrintingRequest(); // FramePrintingRequest | object that holds information on how to build the textual representation
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameId': "xFrameId_example" // String | 
};
apiInstance.printFrame(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**FramePrintingRequest**](FramePrintingRequest.md)| object that holds information on how to build the textual representation | 
 **SID** | **String**| session ID | 
 **xFrameId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="selectFrame"></a>
# **selectFrame**
> FrameMetaData selectFrame(body, SID, opts)

Select frame columns

Creates a new frame by selecting the columns of an existing frame through a column mapping

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.SelectFrameRequest(); // SelectFrameRequest | object that holds information on where to store the frame
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameId': "xFrameId_example" // String | 
};
apiInstance.selectFrame(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SelectFrameRequest**](SelectFrameRequest.md)| object that holds information on where to store the frame | 
 **SID** | **String**| session ID | 
 **xFrameId** | **String**|  | [optional] 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

<a name="storeFrame"></a>
# **storeFrame**
> storeFrame(body, SID, opts)

Store a frame

The PGX server will store the frame to a location specified in the StoreFrameRequest json payload. The server needs to have access to the resource where you want to store the frame to.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.StoreFrameRequest(); // StoreFrameRequest | object that holds information on where to store the frame
let SID = "SID_example"; // String | session ID
let opts = { 
  'xFrameId': "xFrameId_example" // String | 
};
apiInstance.storeFrame(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**StoreFrameRequest**](StoreFrameRequest.md)| object that holds information on where to store the frame | 
 **SID** | **String**| session ID | 
 **xFrameId** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="unionFrames"></a>
# **unionFrames**
> FrameMetaData unionFrames(body, SID)

Unions a set of frames

Creates a new frame by concatenating the rows of the input frames

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.FramesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.UnionFramesRequest(); // UnionFramesRequest | object that holds information on the frames to union
let SID = "SID_example"; // String | session ID

apiInstance.unionFrames(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** | [**UnionFramesRequest**](UnionFramesRequest.md)| object that holds information on the frames to union | 
 **SID** | **String**| session ID | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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