budibase/packages/server/src/integrations/arangodb.ts

import {
  Integration,
  DatasourceFieldType,
  QueryType,
  IntegrationBase,
} from "@budibase/types"

const { Database, aql } = require("arangojs")

interface ArangodbConfig {
  url: string
  username: string
  password: string
  databaseName: string
  collection: string
}

const SCHEMA: Integration = {
  docs: "https://github.com/arangodb/arangojs",
  friendlyName: "ArangoDB",
  type: "Non-relational",
  description:
    "ArangoDB is a scalable open-source multi-model database natively supporting graph, document and search. All supported data models & access patterns can be combined in queries allowing for maximal flexibility. ",
  datasource: {
    url: {
      type: DatasourceFieldType.STRING,
      default: "http://localhost:8529",
      required: true,
    },
    username: {
      type: DatasourceFieldType.STRING,
      default: "root",
      required: true,
    },
    password: {
      type: DatasourceFieldType.PASSWORD,
      required: true,
    },
    databaseName: {
      type: DatasourceFieldType.STRING,
      default: "_system",
      required: true,
    },
    collection: {
      type: DatasourceFieldType.STRING,
      required: true,
    },
  },
  query: {
    read: {
      type: QueryType.SQL,
    },
    create: {
      type: QueryType.JSON,
    },
  },
}

class ArangoDBIntegration implements IntegrationBase {
  private config: ArangodbConfig
  private client: any

  constructor(config: ArangodbConfig) {
    const newConfig = {
      url: config.url,
      databaseName: config.databaseName,
      auth: {
        username: config.username,
        password: config.password,
      },
    }

    this.config = config
    this.client = new Database(newConfig)
  }

  async read(query: { sql: any }) {
    try {
      const result = await this.client.query(query.sql)
      return result.all()
    } catch (err) {
      // @ts-ignore
      console.error("Error querying arangodb", err.message)
      throw err
    } finally {
      this.client.close()
    }
  }

  async create(query: { json: any }) {
    const clc = this.client.collection(this.config.collection)
    try {
      const result = await this.client.query(
        aql`INSERT ${query.json} INTO ${clc} RETURN NEW`
      )
      return result.all()
    } catch (err) {
      // @ts-ignore
      console.error("Error querying arangodb", err.message)
      throw err
    } finally {
      this.client.close()
    }
  }
}

export default {
  schema: SCHEMA,
  integration: ArangoDBIntegration,
}