SDK Reference

Reference

SDK Reference

Complete API reference for the Graph OLAP Python SDK

2 min Beginner

ReferenceIndex

SDK Reference Notebooks

This directory contains executable reference notebooks for every public class in the Graph OLAP SDK. Each notebook demonstrates all methods with parameter tables, return types, and runnable examples.

Client

Notebook	Class	Role	Description
grapholap_client.ipynb	GraphOLAPClient	analyst	Client construction, from_env(), quick_start(), context manager
instance_resource.ipynb	InstanceResource	analyst	Instance CRUD, lifecycle, health checks
instance_connection.ipynb	InstanceConnection	analyst	Query execution, result conversion, schema, locks
mapping_resource.ipynb	MappingResource	analyst	Mapping CRUD, versioning, snapshots

Algorithms

Notebook	Class	Role	Description
algorithms.ipynb	AlgorithmManager + NetworkXManager	analyst	Native algorithms, NetworkX bridge, generic run()

Data & Discovery

Notebook	Class	Role	Description
schema_resource.ipynb	SchemaResource	analyst	Catalog, schema, table, and column exploration
favorite_resource.ipynb	FavoriteResource	analyst	Bookmark frequently used resources
health_resource.ipynb	HealthResource	analyst	Platform health and readiness checks

Administration

Notebook	Class	Role	Description
user_resource.ipynb	UserResource	admin	User CRUD, roles, deactivation
admin_resource.ipynb	AdminResource	admin	Bulk delete with dry-run safety
ops_resource.ipynb	OpsResource	ops	Lifecycle, concurrency, maintenance, jobs

Types & Errors

Notebook	Class	Role	Description
models.ipynb	All model classes	analyst	Data classes, enums, PaginatedList
exceptions.ipynb	Exception hierarchy	analyst	Error handling patterns, exception_from_response()