Reference for hub_sdk/base/crud_client.py
Note
This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/crud_client.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
hub_sdk.base.crud_client.CRUDClient
Bases: APIClient
Represents a CRUD (Create, Read, Update, Delete) client for interacting with a specific resource.
Attributes:
Name | Type | Description |
---|---|---|
name |
str
|
The name associated with the CRUD operations (e.g., "User"). |
logger |
Logger
|
An instance of the logger for logging purposes. |
Source code in hub_sdk/base/crud_client.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
|
__init__(base_endpoint, name, headers)
Initialize a CRUDClient instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base_endpoint |
str
|
The base endpoint URL for the API. |
required |
name |
str
|
The name associated with the CRUD operations (e.g., "User"). |
required |
headers |
dict
|
Headers to be included in API requests. |
required |
Source code in hub_sdk/base/crud_client.py
create(data)
Create a new entity using the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data |
dict
|
The data to be sent as part of the creation request. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the create request, or None if upload fails. |
Source code in hub_sdk/base/crud_client.py
delete(id, hard=False)
Delete an entity using the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
The unique identifier of the entity to delete. |
required |
hard |
bool
|
If True, perform a hard delete. If False, perform a soft delete. |
False
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the delete request, or None if delete fails. |
Source code in hub_sdk/base/crud_client.py
list(page=0, limit=10)
List entities using the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
page |
int
|
The page number to retrieve. |
0
|
limit |
int
|
The maximum number of entities per page. |
10
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the list request, or None if it fails. |
Source code in hub_sdk/base/crud_client.py
read(id)
Retrieve details of a specific entity.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
The unique identifier of the entity to retrieve. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the read request, or None if read fails. |
Source code in hub_sdk/base/crud_client.py
update(id, data)
Update an existing entity using the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
id |
str
|
The unique identifier of the entity to update. |
required |
data |
dict
|
The updated data to be sent in the update request. |
required |
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the update request, or None if update fails. |