surrealdb.node

The official SurrealDB library for Node.js.

  What is SurrealDB?

SurrealDB is an end-to-end cloud-native database designed for modern applications, including web, mobile, serverless, Jamstack, backend, and traditional applications. With SurrealDB, you can simplify your database and API infrastructure, reduce development time, and build secure, performant apps quickly and cost-effectively.

Key features of SurrealDB include:

• Reduces development time: SurrealDB simplifies your database and API stack by removing the need for most server-side components, allowing you to build secure, performant apps faster and cheaper.
• Real-time collaborative API backend service: SurrealDB functions as both a database and an API backend service, enabling real-time collaboration.
• Support for multiple querying languages: SurrealDB supports SQL querying from client devices, GraphQL, ACID transactions, WebSocket connections, structured and unstructured data, graph querying, full-text indexing, and geospatial querying.
• Granular access control: SurrealDB provides row-level permissions-based access control, giving you the ability to manage data access with precision.

View the features, the latest releases, the product roadmap, and documentation.

  Getting started

// import as ES module or common JS
const { default: Surreal } = require('surrealdb.node');

const db = new Surreal();

async function main() {
	try {

		// Use any of these 3 connect methods to connect to the database
		// 1.Connect to the database
		await db.connect('http://127.0.0.1:8000/rpc');
		// 2. Connect to database server
		await db.connect('ws://127.0.0.1:8000');
		// 3. Connect via rocksdb file
		await db.connect(`rocksdb://${process.cwd()}/test.db`);

		// Signin as a namespace, database, or root user
		await db.signin({
			username: 'root',
			password: 'root',
		});

		// Select a specific namespace / database
		await db.use({ namespace: 'test', database: 'test' });

		// Create a new person with a random id
		let created = await db.create('person', {
			title: 'Founder & CEO',
			name: {
				first: 'Tobie',
				last: 'Morgan Hitchcock',
			},
			marketing: true,
			identifier: Math.random().toString(36).slice(2, 12),
		});

		// Update a person record with a specific id
		let updated = await db.merge('person:jaime', {
			marketing: true,
		});

		// Select all people records
		let people = await db.select('person');

		// Perform a custom advanced query
		let groups = await db.query(
			'SELECT marketing, count() FROM type::table($tb) GROUP BY marketing',
			{
				tb: 'person',
			}
		);
	} catch (e) {
		console.error('ERROR', e);
	}
}

main();

Supported targets