Skip to content

chore(docs): update surrealdb.mdx #11905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 26, 2024
Merged

chore(docs): update surrealdb.mdx #11905

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f8ac35
Update surrealdb.mdx
liamwh Sep 25, 2024
feaaa60
fix: correct params to surrealDB adapter
liamwh Sep 25, 2024
e7c4d34
Update surrealdb.mdx
balazsorban44 Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 36 additions & 18 deletions docs/pages/getting-started/adapters/surrealdb.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,27 +104,36 @@ The SurrealDB adapter does not handle connections automatically, so you will hav
```ts filename="./lib/surrealdb.ts"
import { Surreal } from "surrealdb.js"

const connectionString = process.env.AUTH_SURREALDB_CONNECTION
const user = process.env.AUTH_SURREALDB_USERNAME
const pass = process.env.AUTH_SURREALDB_PASSWORD
const ns = process.env.AUTH_SURREALDB_NS
const db = process.env.AUTH_SURREALDB_DB
const connectionString = process.env.AUTH_SURREALDB_CONNECTION;
const username = process.env.AUTH_SURREALDB_USERNAME;
const password = process.env.AUTH_SURREALDB_PASSWORD;
const namespace = process.env.AUTH_SURREALDB_NAMESPACE;
const database = process.env.AUTH_SURREALDB_DATABASE;
if (!connectionString || !username || !password || !namespace || !database) {
throw new Error(
'SurrealDB connection string, username, password, namespace, and database are required'
);
}


const clientPromise = new Promise<Surreal>(async (resolve, reject) => {
const db = new Surreal()
try {
await db.connect(`${connectionString}/rpc`, {
ns,
db,
auth: { user, pass },
namespace,
database,
auth: {
username,
password
}
})
resolve(db)
} catch (e) {
reject(e)
}
})

// Export a module-scoped MongoClient promise. By doing this in a
// Export a module-scoped Promise<Surreal>. By doing this in a
// separate module, the client can be shared across functions.
export default clientPromise
```
Expand All @@ -136,20 +145,29 @@ Useful in serverless environments like Vercel.
```ts filename="./lib/surrealdb.ts"
import { ExperimentalSurrealHTTP } from "surrealdb.js"

const connectionString = process.env.AUTH_SURREALDB_CONNECTION
const user = process.env.AUTH_SURREALDB_USERNAME
const pass = process.env.AUTH_SURREALDB_PASSWORD
const ns = process.env.AUTH_SURREALDB_NS
const db = process.env.AUTH_SURREALDB_DB
const connectionString = process.env.AUTH_SURREALDB_CONNECTION;
const username = process.env.AUTH_SURREALDB_USERNAME;
const password = process.env.AUTH_SURREALDB_PASSWORD;
const namespace = process.env.AUTH_SURREALDB_NAMESPACE;
const database = process.env.AUTH_SURREALDB_DATABASE;
if (!connectionString || !username || !password || !namespace || !database) {
throw new Error(
'SurrealDB connection string, username, password, namespace, and database are required'
);
}


const clientPromise = new Promise<ExperimentalSurrealHTTP<typeof fetch>>(
async (resolve, reject) => {
try {
const db = new ExperimentalSurrealHTTP(connectionString, {
fetch,
ns,
db,
auth: { user, pass },
namespace,
database,
auth: {
username,
password
}
})
resolve(db)
} catch (e) {
Expand All @@ -158,7 +176,7 @@ const clientPromise = new Promise<ExperimentalSurrealHTTP<typeof fetch>>(
}
)

// Export a module-scoped MongoClient promise. By doing this in a
// Export a module-scoped Promise<Surreal>. By doing this in a
// separate module, the client can be shared across functions.
export default clientPromise
```
Loading