Collections

On the Collections tab, you can view all the collections created for the database service. At the top search bar, you can provide the name of the collection and search for it's details. You can filter the list of collections by its status field next to search bar. And also filter the list by owner field. Select Clear button to clear the filter setting and revert to the default. At the extreme right there is Create Collection button that helps to create the new collection. Follow the steps to create a new collection:

  • Create Collection - Select + Create Collection button on the top-right corner to create a new collection.

    • Collection Name - Provide the name for your collection. The name should start with an underscore, a lowercase letter, or an uppercase letter and consist only of alphanumeric characters and underscores, within a length range of 1 to 255 characters.

    • Description - Provide any description for your collection.

    • Schema - Under Schema provide the details including the primary field and the vector field. Each row is added as a field in the schema. The Field Name should start with an underscore, a lowercase letter, or an uppercase letter and consist only of alphanumeric characters and underscores, within a length range of 1 to 255 characters.

      • The first row is for the primary field, provide the Field Name, select the Field Type from the drop down list of available data types, and enable/disable the AutoID for Index Parameters. It takes Index Type and Index Name automatically for the primary field.

      • The second row is for Vector field, provide the Field Name, select the Field Type from the drop down list of available data types, optionally provide the Index Name, provide Dimensions, and select the Metric Type from the drop down list.

      • Optionally, click on + Add New Field to add further fields. Provide the Field Name and select the Field Type from the available list of data types in the drop down list. You can add n number of fields in the collection.

    • Partition Key - The Partition Key field gets enabled only after you add third field. Select the field from the drop-down list as the partition key. The non-primary/non-vector fields are available to be the partition key.

    • Dynamic Schema - Enable/Disable the Dynamic Schema using the toggle button. If it is enabled, you can flexibly add more fields that are not-predefind in the schema.

The fields in the table provide the information of all the collections. Each row provides information about the respective collection:

  • Name - Provides the name of the collection defined at the time of creation.

  • Status - Provides the status of the collection. The status of the collection can be:

    Status
    Description

    LOADED

    It displays LOADED status when the collection is loaded into the memory from the disk.

    UNLOADED

    It displays UNLOADED status when the collection is released from the memory and it is now on the disk.

    DELETED

    It displays DELETED status after the deletion trigger is executed.

    RELEASING

    It displays RELEASING status when the collection is transitioning from LOADED to UNLOADED. The collection is getting unloaded from memory to disk.

    LOADING

    It displays LOADING status when the collection is transitioning from UNLOADED to LOADED. Then collection is getting loaded to memory from disk.

    CREATING

    It diplays CREATING status when the collection creation is triggered and the process of creation is on.

    DELETING

    It displays DELETING status when the delete trigger is executed on the collection and the process of deletion is on.

  • Description - Provides the description of your collection if porivded at the time of creation.

  • Date Modified - Provides the date, month, year, hours, and minutes when the collection is modified.

  • Created By - Provides the email ID of the user created this collection.

You can modify the collection using the ellipsis icon at the right extreme. It has following options:

  • Load - This option is available when the collection is unloaded. Select the Load option to load the collection in the memory from the disk.

  • Unload - This option is available when the collection is loaded. Select the Unload option to unload the collection from memory to disk. While transitioning from Loaded to Unloaded the collection is in Releasing status.

  • Delete - This option is available whether the colleciton is in loaded or unloaded state. Select Delete option if the collection is not needed anymore. This action can't be undone.

Last updated