Skip to main content

Create Group

The group creation functionality enables the organization and management of documents within a database by grouping them under specified categories. This can help facilitate access control, permissions management, and operations organization within a Zero-Knowledge Database (zkDatabase).

Definition​

The create method is used to create a new group within a specified database, adding structure and categorization to the database.

await zkdb
  .db(databaseName: string)
  .group(groupName: string)
  .create({ groupDescription?: string }): Promise<boolean>;

Parameters​

  • groupName: string - The name of the new group to be created. This identifier categorizes a set of collections or documents under a common label for easier management.
  • groupDescription: string - A textual description of the group, providing insight into its purpose or the type of documents it is intended to encompass. This description aids in understanding the role and context of the group within the database.

Returns​

  • Promise<boolean>: Returns true when the group is successfully created with the specified name and description. The group becomes immediately available for user assignment and collection access control, with the database owner automatically having administrative permissions.

Example​

await zkdb
  .database("my_db")
  .group("test")
  .create({ groupDescription: "My first test group" });
Default 'admin' Group

When a database is created, a default 'admin' group is automatically created and assigned to the database owner. This group is used as the default group for collections when no specific group is specified during collection creation.

Important Notes​

  • Owner-Only Operation: Only the database owner has the permissions required to create a group. Ensure that your application logic checks user roles and ownership before attempting to call createGroup.

  • Unique Group Names: Group names must be unique within the database. Attempting to create a group with a duplicate name will result in an error.

Use Case: Managing Permissions with Groups​

Creating groups is essential for managing permissions effectively in a database. By grouping users based on their roles or responsibilities, you can simplify permission management by assigning permissions at the group level rather than individually for each user.

For example, you might create groups such as "Admins", "Editors", or "Viewers" and assign them varying levels of access to different collections or documents. This approach enhances both security and ease of management.

Summary​

The createGroup method in zkDatabase provides a powerful way to manage user permissions by grouping users within a database. This method is restricted to database owners, ensuring that only authorized users can modify group structures and permissions, thus maintaining the integrity and security of the database.