Git Product home page Git Product logo

arangodblite's Introduction

alt tag

ArangoDBLite

ArangoDBLite is a lightweight SDK for the RESTful API provided by the ArangoDB graph database platform (see https://www.arangodb.com/).

NuGet Version NuGet

Help, Feedback, Contribute

If you have any issues or feedback, please file an issue here in Github. We'd love to have you help by contributing code for new features, optimization to the existing codebase, ideas for future releases, or fixes!

Overview

This project was built to provide a dead simple interface to interact with ArangoDB. It is not meant to be complete, but rather, optimized for the simplest possible workflows and integration.

New in v1.0.x

  • Initial release
  • Fix for First APIs
  • Include cursor query in log messages

Example Project

Refer to the Test project for exercising each of the library APIs.

Simple Example

All APIs (see list below) return an object of type AdbResult, which contains many of the properties found in the Arango RESTful API response.

The response data can be found in AdbResult.Result (which should be cast to the appropriate type), AdbResult.Graphs (a list of AdbGraph objects), or AdbResult.Graph (an individual AdbGraph object).

Refer to the documentation for each API to understand the type of object contained in AdbResult.Result.

using ArangoDBLite;

AdbClient client = new AdbClient("root", "root", "http://127.0.0.1:8529/");
AdbResult result = null;

// list databases
result = await client.ListDatabases();
List<string> dbNames = result.Result as List<string>;

// add database
result = await client.CreateDatabase("MyDatabase");
bool success = result.Result as bool;

// get users
result = await client.ListUsers();
List<AdbUser> users = result.Result as List<AdbUser>;

// execute a cursor query
result = await client.ExecuteCursorQuery<AdbVertex>("FOR v IN vertices RETURN v");
List<AdbVertex> vertices = result.Result as List<AdbVertex>;

APIs Provided

The following APIs are provided:

  • Database - list, exists, create, delete
  • Users - list, get, exists, create, delete
  • Collections - list, get, exists, create, delete
  • Graphs - list, get, exists, create, delete, add edge collection
  • Vertices - list (using cursor query), create, update, replace, get, delete, first
  • Edges - list (using cursor query), create, update, replace, get, delete, first
  • Cursor queries - execute

Version History

Refer to CHANGELOG.md for version history.

arangodblite's People

Contributors

jchristn avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

bangush

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.