Skip to content

Commit b86f7bb

Browse files
docs(providers): update surrealdb.mdx (#11905)
* Update surrealdb.mdx * fix: correct params to surrealDB adapter * Update surrealdb.mdx --------- Co-authored-by: Balázs Orbán <[email protected]>
1 parent 532761a commit b86f7bb

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

docs/pages/getting-started/adapters/surrealdb.mdx

+32-16
Original file line numberDiff line numberDiff line change
@@ -105,26 +105,34 @@ The SurrealDB adapter does not handle connections automatically, so you will hav
105105
import { Surreal } from "surrealdb.js"
106106

107107
const connectionString = process.env.AUTH_SURREALDB_CONNECTION
108-
const user = process.env.AUTH_SURREALDB_USERNAME
109-
const pass = process.env.AUTH_SURREALDB_PASSWORD
110-
const ns = process.env.AUTH_SURREALDB_NS
111-
const db = process.env.AUTH_SURREALDB_DB
108+
const username = process.env.AUTH_SURREALDB_USERNAME
109+
const password = process.env.AUTH_SURREALDB_PASSWORD
110+
const namespace = process.env.AUTH_SURREALDB_NAMESPACE
111+
const database = process.env.AUTH_SURREALDB_DATABASE
112+
if (!connectionString || !username || !password || !namespace || !database) {
113+
throw new Error(
114+
"SurrealDB connection string, username, password, namespace, and database are required"
115+
)
116+
}
112117

113118
const clientPromise = new Promise<Surreal>(async (resolve, reject) => {
114119
const db = new Surreal()
115120
try {
116121
await db.connect(`${connectionString}/rpc`, {
117-
ns,
118-
db,
119-
auth: { user, pass },
122+
namespace,
123+
database,
124+
auth: {
125+
username,
126+
password,
127+
},
120128
})
121129
resolve(db)
122130
} catch (e) {
123131
reject(e)
124132
}
125133
})
126134

127-
// Export a module-scoped MongoClient promise. By doing this in a
135+
// Export a module-scoped Promise<Surreal>. By doing this in a
128136
// separate module, the client can be shared across functions.
129137
export default clientPromise
130138
```
@@ -137,19 +145,27 @@ Useful in serverless environments like Vercel.
137145
import { ExperimentalSurrealHTTP } from "surrealdb.js"
138146

139147
const connectionString = process.env.AUTH_SURREALDB_CONNECTION
140-
const user = process.env.AUTH_SURREALDB_USERNAME
141-
const pass = process.env.AUTH_SURREALDB_PASSWORD
142-
const ns = process.env.AUTH_SURREALDB_NS
143-
const db = process.env.AUTH_SURREALDB_DB
148+
const username = process.env.AUTH_SURREALDB_USERNAME
149+
const password = process.env.AUTH_SURREALDB_PASSWORD
150+
const namespace = process.env.AUTH_SURREALDB_NAMESPACE
151+
const database = process.env.AUTH_SURREALDB_DATABASE
152+
if (!connectionString || !username || !password || !namespace || !database) {
153+
throw new Error(
154+
"SurrealDB connection string, username, password, namespace, and database are required"
155+
)
156+
}
144157

145158
const clientPromise = new Promise<ExperimentalSurrealHTTP<typeof fetch>>(
146159
async (resolve, reject) => {
147160
try {
148161
const db = new ExperimentalSurrealHTTP(connectionString, {
149162
fetch,
150-
ns,
151-
db,
152-
auth: { user, pass },
163+
namespace,
164+
database,
165+
auth: {
166+
username,
167+
password,
168+
},
153169
})
154170
resolve(db)
155171
} catch (e) {
@@ -158,7 +174,7 @@ const clientPromise = new Promise<ExperimentalSurrealHTTP<typeof fetch>>(
158174
}
159175
)
160176

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

0 commit comments

Comments
 (0)