few-line-engine/out/js/docs/DatabaseManagementApi.md

LowCodeEngineApi.DatabaseManagementApi

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
databaseColumnsDatabaseIdTableNameGet	GET /database/columns/{databaseId}/{tableName}	Get table columns
databaseCreatePost	POST /database/create	Create database
databaseMigrationCreatePost	POST /database/migration/create	Create migration
databaseMigrationDownDatabaseIdGet	GET /database/migration/down/{databaseId}	Run migrations down
databaseMigrationUpDatabaseIdGet	GET /database/migration/up/{databaseId}	Run migrations up
databaseNodeCreatePost	POST /database/node/create	Add database node
databaseQueryDatabaseIdPost	POST /database/query/{databaseId}	Run database query
databaseTablesDatabaseIdGet	GET /database/tables/{databaseId}	Get database tables

databaseColumnsDatabaseIdTableNameGet

[Object] databaseColumnsDatabaseIdTableNameGet(databaseId, tableName)

Get table columns

Retrieve columns information for a specific table

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseId = "databaseId_example"; // String | Database ID
let tableName = "tableName_example"; // String | Table name
apiInstance.databaseColumnsDatabaseIdTableNameGet(databaseId, tableName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
databaseId	String	Database ID
tableName	String	Table name

Return type

[Object]

Authorization

ApiKeyAuth

HTTP request headers

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

databaseCreatePost

Database databaseCreatePost(databaseCreatePostRequest)

Create database

Create a new database for a project

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: AdminAuth
let AdminAuth = defaultClient.authentications['AdminAuth'];
AdminAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//AdminAuth.apiKeyPrefix = 'Token';
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseCreatePostRequest = new LowCodeEngineApi.DatabaseCreatePostRequest(); // DatabaseCreatePostRequest | 
apiInstance.databaseCreatePost(databaseCreatePostRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
databaseCreatePostRequest	DatabaseCreatePostRequest

Return type

Database

Authorization

AdminAuth, ApiKeyAuth

HTTP request headers

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

databaseMigrationCreatePost

Migration databaseMigrationCreatePost(databaseMigrationCreatePostRequest)

Create migration

Create a new database migration

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseMigrationCreatePostRequest = new LowCodeEngineApi.DatabaseMigrationCreatePostRequest(); // DatabaseMigrationCreatePostRequest | 
apiInstance.databaseMigrationCreatePost(databaseMigrationCreatePostRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
databaseMigrationCreatePostRequest	DatabaseMigrationCreatePostRequest

Return type

Migration

Authorization

ApiKeyAuth

HTTP request headers

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

databaseMigrationDownDatabaseIdGet

databaseMigrationDownDatabaseIdGet(databaseId)

Run migrations down

Rollback database migrations

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseId = "databaseId_example"; // String | Database ID
apiInstance.databaseMigrationDownDatabaseIdGet(databaseId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
databaseId	String	Database ID

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

databaseMigrationUpDatabaseIdGet

databaseMigrationUpDatabaseIdGet(databaseId)

Run migrations up

Execute pending database migrations

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseId = "databaseId_example"; // String | Database ID
apiInstance.databaseMigrationUpDatabaseIdGet(databaseId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name	Type	Description	Notes
databaseId	String	Database ID

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

databaseNodeCreatePost

DatabaseNode databaseNodeCreatePost(databaseNodeCreatePostRequest)

Add database node

Add a new database node to the system

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: AdminAuth
let AdminAuth = defaultClient.authentications['AdminAuth'];
AdminAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//AdminAuth.apiKeyPrefix = 'Token';
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseNodeCreatePostRequest = new LowCodeEngineApi.DatabaseNodeCreatePostRequest(); // DatabaseNodeCreatePostRequest | 
apiInstance.databaseNodeCreatePost(databaseNodeCreatePostRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
databaseNodeCreatePostRequest	DatabaseNodeCreatePostRequest

Return type

DatabaseNode

Authorization

AdminAuth, ApiKeyAuth

HTTP request headers

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

databaseQueryDatabaseIdPost

Object databaseQueryDatabaseIdPost(databaseId, databaseQueryDatabaseIdPostRequest)

Run database query

Execute a SQL query on the database

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseId = "databaseId_example"; // String | Database ID
let databaseQueryDatabaseIdPostRequest = new LowCodeEngineApi.DatabaseQueryDatabaseIdPostRequest(); // DatabaseQueryDatabaseIdPostRequest | 
apiInstance.databaseQueryDatabaseIdPost(databaseId, databaseQueryDatabaseIdPostRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
databaseId	String	Database ID
databaseQueryDatabaseIdPostRequest	DatabaseQueryDatabaseIdPostRequest

Return type

Object

Authorization

ApiKeyAuth

HTTP request headers

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

databaseTablesDatabaseIdGet

[String] databaseTablesDatabaseIdGet(databaseId)

Get database tables

Retrieve list of tables in a database

Example

import LowCodeEngineApi from 'low_code_engine_api';
let defaultClient = LowCodeEngineApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new LowCodeEngineApi.DatabaseManagementApi();
let databaseId = "databaseId_example"; // String | Database ID
apiInstance.databaseTablesDatabaseIdGet(databaseId, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
databaseId	String	Database ID

Return type

[String]

Authorization

ApiKeyAuth

HTTP request headers

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