SurrealDB Docs Logo

Enter a search query

->insert()

Inserts one or multiple records in the database.

Method Syntax
$db->insert(thing, data)

Arguments

ArgumentsDescription
thing required

The table name or RecordId to insert to.

data optional

Either a single document/record or an array of documents/records to insert

Example usage

// Insert a single record
[$person] = $db->insert('person', [
	"name" => 'Tobie',
	"settings" => [
		"active" => true,
		"marketing" => true,
	],
]);

$person = $db->insert(new RecordId('person', 'tobie'), [
	"name" => 'Tobie',
	"settings" => [
		"active" => true,
		"marketing" => true,
	],
]);

// Insert multiple records
$people = $db->insert('person', [
	[
		"name" => 'Tobie',
		"settings" => [
			"active" => true,
			"marketing" => true,
		],
	],
	[
		"name" => 'Jaime',
		"settings" => [
			"active" => true,
			"marketing" => true,
		],
	],
]);

// The content you are creating the record with might differ from the return type
$people = $db->insert('person', [
	[ "name" => 'Tobie' ],
	[ "name" => 'Jaime' ],
]);

Translated query

This function will run the following query in the database.

INSERT INTO $thing $data;

On this page

© SurrealDB GitHub Discord Community Cloud Features Releases Install