deno_surreal

Simple library for querying a SurrealDB database

Disclaimer! This project is not meant to be a replacement or contender to any official tools/libraries. It is not stable, and exists merely because I wanted to do a small project involving SurrealDB.

This library has no dependencies.

Updated for beta-8 release.

For documentation on SurrealDB go to the official SurrealDB Website.

Create a SurrealDB connection:

Make sure it is the base url to your hosted database, and includes the port.

As of now only allows basic authentication.

import { SurrealDB } from "https://deno.land/x/deno_surreal/mod.ts"

const db = new SurrealDB({
  host: "http://localhost:8000",
  user: "root",
  pass: "root",
  namespace: "test",
  database: "test"
})

Update username / password:

You could also choose to only update one.

db.signin({
  user: "username",
  pass: "password"
})

Use a different namespace / database:

You could also choose to only update one.

db.use({
  namespace: "test2", 
  database: "test2"
})

Create a new table record:

Typing is optional.

All requests will throw an error upon receiving an error result from the database. This is less likely to happen with fixed queries.

type Person = {
  id: string
  name: string,
  age: number
}

const p1 = await db.create<Person>("person:1", {
  name: "Max Manus",
  age: 32
})

console.log(p1) // Prints: { age: 32, id: "person:1", name: "Max Manus" }

Select one or more records from a table:

const result1 = await db.select<Person>("person")
const result2 = await db.select<Person>("person:1")

Delete one or more records from a table:

await db.delete("person") // Delete all people
await db.delete("person:1") // Delete only person with id "person:1"

Update a specific record:

const p1 = await db.update<Person>("person:1", {
  name: "Maxy",
  age: 98
})
console.log(p1) // Prints: { age: 98, id: "person:1", name: "Maxy" }

Modify a specific record:

const p1 = await db.modify<Person>("person:1", {
  age: 57
})
console.log(p1) // Prints: { age: 57, id: "person:1", name: "Max Manus" }

Execute custom queries:

Can execute multiple queries in one request, returns a list of result lists.

const queryStr = `
  SELECT * FROM person;
  SELECT * FROM person WHERE age < 18;
`

try {
  const [ people, peopleUnder18 ] = await db.query(queryStr)
  console.log(people) // Prints: [ { age: 32, id: "person:1", name: "Max Manus" }
  console.log(peopleUnder18) // Prints: []
} catch(err) {
  console.error(err)
}

Execute a single custom query:

Will only execute the first query if multiple are present, returns a single result list.

try {
  const peopleNamedMax = await db.singleQuery<Person>("SELECT * FROM person WHERE name = 'Max Manus'")
  console.log(peopleNamedMax) 
  // Prints: [ { age: 32, id: "person:1", name: "Max Manus" } ]
} catch(err) {
  console.error(err)
}

Execute custom queries and receive the raw query results:

Will retain erronous query results.

const queryStr = `
SELECT * FROM person;
SELECT * FROM person WHERE age < 18;
`

try {
  const queryResults = await db.rawQuery(queryStr)
  queryResults.forEach(qr => {
    if (qr.status === "ERR") {
      // Handle erronous result
    }
    else {
      const result =  qr.result
    }
  })
} catch(err) {
  console.error(err)
}