feature: add count method to InfrahubClient

[wvandeun]

Component

Python SDK

Describe the Feature Request

Add a count method that allows you to count the kind of objects that match your query:

from infrahub_sdk import InfrahubClient
client = InfrahubClient()
num_devices = await client.count(kind="InfraDevice", site__name__value="alt1")

Describe the Use Case

In scenarios where I would need to count the amount of objects that match a query, I have 2 options today:

• retrieve the objects and take the length of the resulting list, which could be expensive, because we would automatically fetch attributes and relationships of cardinality one
• construct a raw GraphQL query

The above approaches are not ideal and we could make this more simple and less expensive.

Additional Information

No response

[wvandeun]

Today, we can achieve the same using a GraphQL query:

from infrahub_sdk import InfrahubClientSync
client = InfrahubClientSync()
query = "query { BuiltinTag { count }}"
resp = client.execute_graphql(query=query)
print(resp["BuiltinTag"]["count"])