Skip to main content
Version: V1.1.0

fork - Fork a collection

The fork() method is used to create a new collection with the same data as the specified collection.

info
  • In seekdb V1.1.0, FORK TABLE is provided as an experimental feature and is not recommended for production use.
  • This API can only be used when connected with SeekdbClient. For more information about SeekdbClient, see SeekdbClient.

Prerequisites​

  • You have installed seekdb-js. For more information, see Quick start.

  • You have installed the server mode of seekdb. For more information, see Deploy seekdb by using yum install.

  • You are connected to the database. For more information, see SeekdbClient.

  • The collection to be forked exists. If the collection does not exist, an error will be returned.

Request parameters​

fork("forkCollection");
ParameterTypeRequiredDescriptionExample value
namestring | string[]YesThe name of the new collection.fork_collection

Request example​

import { SeekdbClient } from "seekdb";

const client = new SeekdbClient({
  host: "127.0.0.1",
  port: 2881,
  user: "root",
  password: "",
  database: "test",
});

const collection = await client.getCollection({name: 'my_collection'});

const forkCollection = await collection.fork('fork_collection');

Response parameters​

Returns a forked collection.

Contents

Edit this page