Collection Management

A collection in R2R is a logical grouping of users and documents that allows for efficient access control and organization. Collections enable you to manage permissions and access to documents at a collection level, rather than individually.

R2R provides a comprehensive set of collection features, allowing you to implement efficient access control and organization of users and documents in your applications.

Collection creation and Management

Create a Collection

Create a new collection with a name and optional description:

1
create_collection_response = client.create_collection("Marketing Team", "Collection for marketing department")
2
collection_id = create_collection_response["results"]["collection_id] # '123e4567-e89b-12d3-a456-426614174000'

Get Collection details

Retrieve details about a specific collection:

1
collection_details = client.get_collection(collection_id)

Update a Collection

Update a collection’s name or description:

1
update_result = client.update_collection(
2
  collection_id,
3
  name="Updated Marketing Team",
4
  description="New description for marketing team"
5
)

List Collections

Get a list of all collections:

1
collections_list = client.list_collections()

User Management in Collections

Add User to Collection

Add a user to a collection:

1
user_id = '456e789f-g01h-34i5-j678-901234567890'  # This should be a valid user ID
2
add_user_result = client.add_user_to_collection(user_id, collection_id)

Remove User from Collection

Remove a user from a collection:

1
remove_user_result = client.remove_user_from_collection(user_id, collection_id)

List Users in Collection

Get a list of all users in a specific collection:

1
users_in_collection = client.get_users_in_collection(collection_id)

Get User’s Collections

Get all collections that a user is a member of:

1
user_collections = client.user_collections(user_id)

Document Management in Collections

Assign Document to Collection

Assign a document to a collection:

1
document_id = '789g012j-k34l-56m7-n890-123456789012' # must be a valid document id
2
assign_doc_result = client.assign_document_to_collection(document_id, collection_id)

Remove Document from Collection

Remove a document from a collection:

1
remove_doc_result = client.remove_document_from_collection(document_id, collection_id)

List Documents in Collection

Get a list of all documents in a specific collection:

1
docs_in_collection = client.documents_in_collection(collection_id)

Get Document’s Collections

Get all collections that a document is assigned to:

1
document_collections = client.document_collections(document_id)

Advanced Collection Management

Collection Overview

Get an overview of collections, including user and document counts:

1
collections_overview = client.collections_overview()

Delete a Collection

Delete a collection:

1
delete_result = client.delete_collection(collection_id)

Pagination and Filtering

Many collection-related methods support pagination and filtering:

1
# List collections with pagination
2
paginated_collection = client.list_collections(offset=10, limit=20)
3
4
# Get users in a collection with pagination
5
paginated_users = client.get_users_in_collection(collection_id, offset=5, limit=10)
6
7
# Get documents in a collection with pagination
8
paginated_docs = client.documents_in_collection(collection_id, offset=0, limit=50)
9
10
# Get collections overview with specific collection IDs
11
specific_collections_overview = client.collections_overview(collection_ids=['id1', 'id2', 'id3'])

Security Considerations

When implementing collection permissions, consider the following security best practices:

1. Always use HTTPS in production to encrypt data in transit.
2. Implement the principle of least privilege by assigning the minimum necessary permissions to users and collections.
3. Regularly audit collection memberships and document assignments.
4. Ensure that only authorized users (e.g., admins) can perform collection management operations.
5. Implement comprehensive logging for all collection-related actions.
6. Consider implementing additional access controls or custom roles within your application logic for more fine-grained permissions.

For more advanced use cases or custom implementations, refer to the R2R documentation or reach out to the community for support.