Organization#

class polars_cloud.Organization(name: str | None = None, *, id: UUID | None = None)

A Polars Cloud organization.

With this class you can list the organizations the user is a member of or set up a new organization

Parameters:

name: The organization name.
id: The organization id.

Examples

>>> pc.Organization("organization-name")
Organization(id=UUID('xxxxxxxx-xxxx-74e0-9de7-6e2014821b44'),
    name='organization-name',

Attributes:

`id`	Organization id.
`name`	Organization name.

Methods:

`load`	Load the organization details (e.g. name, status, id) from the control plane.
`delete`	Delete an organization.
`setup`	Create a new organization.
`list`	List all organizations the user has access to.

property id: UUID: Organization id.

property name: str: Organization name.

load() → None: Load the organization details (e.g. name, status, id) from the control plane.

Note

Depending on the input load will load the Organization object by id / name

delete() → None

Delete an organization.

Examples

>>> pc.Organization("organization-name").delete()

classmethod setup(name: str) → Self

Create a new organization.

Parameters:

name: Name of the organization

Examples

>>> pc.Organization.setup("organization-name)
Organization(id=UUID('xxxxxxxx-xxxx-74e0-9de7-6e2014821b44'),
    name='organization-name',

classmethod list( name: str | None = None, ) → list[Organization]

List all organizations the user has access to.

Parameters:

name: Filter organizations by name prefix.

Examples

>>> pc.Organization.list()
[Organization(id=UUID('xxxxxxxx-xxxx-4d10-a8ee-8f63329329dc'),
    name='organization-name', ,
Organization(id=UUID('xxxxxxxx-xxxx-7863-80d6-fb4959c59856'),
    name='different-organization',]