Reference

Overwrite default behaviour.

Return the number of pages in this database.

Create a page with properties according to the schema within the corresponding database.

Delete this database.

Fetch all pages and return a view.

Return a Pydantic model for this database.

Query a (large) database for pages in a more specific way.

Reload this database.

Restore this database.

Return the content of this database as Markdown.

Create an Emoji object from a :shortcode:, e.g.

Represent the emoji as :shortcode:, e.g.

Description of the option.

Convert the enum to a list as needed by the (Multi)Select property types.

Delete this page.

Reload this page.

Restore this page.

Show the content of the page, rendered in Jupyter Lab

Return the content of the page as HTML.

Return the content of the page as Markdown.

Return the schema in a given string table format.

Some table formats:

• plain: no pseudographics
• simple: Pandoc's simple table, i.e. only dashes to separate header from content
• github: GitHub flavored Markdown
• simple_grid: uses dashes & pipes to separate cells
• html: standard html markup

Find more table formats under: astanin/python-tabulate#table-format

Bind the PageSchema to the corresponding database for back-reference.

Create a page using this schema with a bound database.

Creation of a schema from a dictionary for easy support of dynamically created schemas.

Get the database that is bound to this schema.

Get a specific property from this schema assuming that property names are unique.

Get all properties of this schema.

Returns the property holding the title of the pages.

Determines if the schema is bound to a database.

Is this schema consistent with another ignoring backward relations if not in other schema.

Show the schema as html or as simple table.

Convert this schema to a dictionary.

Create RichTextList by parsing the markdown.

Create RichTextList from plain text.

This method is a more explicit alias for the default constructor.

Return rich text as HTML.

Convert the list of RichText objects to markdown.

Return rich text as plaintext

This method is a more explicit variant then just using the object.

Retrieve all users of this workspace.

Close the session and release resources.

Create a new database within a page.

Implementation:

1. initialize external forward relations, i.e. relations pointing to other databases
2. create the database using a Notion API call and potential external forward relations
3. initialize self-referencing forward relations
4. create properties with self-referencing forward relations using an update call
5. update the backward references, i.e. two-way relations, using an update call

Create new databases in the right order in case there a relations between them.

Create a new page in a parent page.

Return the current active session or None.

Retrieve a single block by an object reference.

Retrieve Notion database by uuid

Return the current active session or create a new session.

Get or create the database.

Retrieve a page by uuid.

Get a user by uuid.

Attention: Trying to retrieve yourself, i.e. the bot integration, only works if whoami() was called before to fill the cache since the low-level api, i.e. api.users.retrieve() does not work for the bot integration.

Determine if the session is closed or not.

Confirm that the session is active and raise otherwise.

Raises SessionError if there is a problem, otherwise returns None.

Search a database by name or return all if db_name is None.

Parameters:

Search a page by name. Deleted pages, i.e. in trash, are not included in the search.

Parameters:

Search a user by name.

Return the user object of this bot.

Return the synced block for appending.

Return the original block.

Return the table as Markdown.