Java Types

Constructor

RootCredential(String username, String password)

Example

db.signin(new RootCredential("root", "root"));

Constructor

NamespaceCredential(String username, String password, String namespace)

Example

db.signin(new NamespaceCredential("ns_user", "ns_pass", "surrealdb"));

Constructor

DatabaseCredential(String username, String password, String namespace, String database)

Example

db.signin(new DatabaseCredential("db_user", "db_pass", "surrealdb", "docs"));

Constructors

RecordCredential(String namespace, String database, String access, Object params)
RecordCredential(String access, Object params)

Example

Token token = db.signup(new RecordCredential(
    "surrealdb", "docs", "user_access",
    Map.of("email", "user@example.com", "password", "s3cret")
));

Constructor

BearerCredential(String token)

Example

db.signin(new BearerCredential("eyJhbGciOiJIUzI1NiIs..."));

Constructors

Token(String access, String refresh)
Token(String token)

Example

Token token = db.signin(new RootCredential("root", "root"));
String jwt = token.getAccess();
String refresh = token.getRefresh();

Example

db.update(Person.class, new RecordId("person", "alice"), UpType.MERGE, updates);

Example

public class Likes extends Relation {
    public String createdAt;
}

Likes like = db.relate(Likes.class,
    new RecordId("person", "alice"),
    "likes",
    new RecordId("post", "post1")
);

Example

public class Likes extends InsertRelation {
    public String createdAt;
}

Likes like = new Likes();
like.in = new RecordId("person", "alice");
like.out = new RecordId("post", "post1");
like.createdAt = "2025-01-01T00:00:00Z";

Likes result = db.insertRelation(Likes.class, "likes", like);