chasleslr / metabase-python Goto Github PK

https://www.metabase.com/docs/latest/api-documentation.html#card

Some resources have created_at and updated_at attributes, which Metabase returns as ISO-formatted timestamps. We should deserialize those as datetime objects.

https://www.metabase.com/docs/latest/api-documentation.html#put-apipermissionsgraph

The Card object currently supports list, create, update, and archive. There is additional functionality in the API that we should support (i.e. POST /api/card/:card-id:/favorite). See docs.

We should create a class that helps with creating queries as expected by the query argument in Dataset.create() (see POST /api/dataset).

This would, at least, serialize to dict (i.e. DatasetQuery(type='query', 'query'={'database': 1, ...}, ...) -> {'type': 'query', 'query': {'database': 1, ...}, ...}), but ideally help with building valid MBQL.

https://www.metabase.com/docs/latest/api-documentation.html#collection

We should add a class that to helps with the creation of Card instances, specifically the visualization_settings argument of Card.create() (see POST /api/card).

Metabase supports naming aggregations, with the compiled MBQL looking as follows:

[["aggregation-options", ["share", [">", ["field", 9, null], 5]],{name: "My Aggregation", display-name: "My Aggregation"}]]

We should support this in Aggregation subclasses.

Metabase allows filtering on fields from another table joined through a foreign key. It compiles the MBQL for such filter as follows:

["=", ["field", 27, {source-field: 11}], 4]

This differs from a "regular" filter on a direct table field:

["=", ["field", 11, null], 5]

Here, {source-field: 11} represents the fieldID of the foreign key in the local table. For example, if using Orders as the base table with a foreign key userID to Users with a name field that we wanted to filter on:

• Users.name has a fieldID = 27 in the example above.
• Orders.userID has a fieldID = 11 in the example above.

We should allow Filter subclasses to filter on fields on foreign tables.

Resource.__init__() should automatically create instances of other resources when appropriate. For example, Card.user should be an instance of User.