grafeo.GrafeoDB¶

The main database class.

Constructor¶

GrafeoDB(
    path: Optional[str] = None
)

Parameters¶

Parameter	Type	Default	Description
`path`	`str`	`None`	Database file path (None for in-memory)

Examples¶

# In-memory database
db = grafeo.GrafeoDB()

# Persistent database
db = grafeo.GrafeoDB("my_graph.db")

Query Methods¶

execute()¶

Execute a GQL query.

def execute(self, query: str, params: Optional[Dict] = None) -> QueryResult

execute_cypher()¶

Execute a Cypher query.

def execute_cypher(self, query: str, params: Optional[Dict] = None) -> QueryResult

execute_gremlin()¶

Execute a Gremlin query.

def execute_gremlin(self, query: str, params: Optional[Dict] = None) -> QueryResult

execute_graphql()¶

Execute a GraphQL query.

def execute_graphql(self, query: str, params: Optional[Dict] = None) -> QueryResult

execute_sparql()¶

Execute a SPARQL query.

def execute_sparql(self, query: str, params: Optional[Dict] = None) -> QueryResult

execute_sql()¶

Execute a SQL/PGQ query.

def execute_sql(self, query: str, params: Optional[Dict] = None) -> QueryResult

Node Operations¶

create_node()¶

Create a node with labels and properties.

def create_node(self, labels: List[str], properties: Optional[Dict[str, Any]] = None) -> Node

add_node_label()¶

Add a label to an existing node.

def add_node_label(self, node_id: int, label: str) -> None

remove_node_label()¶

Remove a label from a node.

def remove_node_label(self, node_id: int, label: str) -> None

get_node_labels()¶

Get all labels for a node.

def get_node_labels(self, node_id: int) -> List[str]

Transaction Methods¶

begin_transaction()¶

Start a new transaction.

def begin_transaction(self, isolation_level: Optional[str] = None) -> Transaction

Admin Methods¶

info()¶

Get database information.

def info(self) -> Dict[str, Any]

detailed_stats()¶

Get detailed statistics.

def detailed_stats(self) -> Dict[str, Any]

schema()¶

Get schema information.

def schema(self) -> Dict[str, Any]

validate()¶

Validate database integrity.

def validate(self) -> bool

Example¶

import grafeo

db = grafeo.GrafeoDB()

# Execute queries
db.execute("INSERT (:Person {name: 'Alix', age: 30})")

result = db.execute("MATCH (p:Person) RETURN p.name")
for row in result:
    print(row['p.name'])

# Use transactions
with db.begin_transaction() as tx:
    tx.execute("INSERT (:Person {name: 'Gus'})")
    tx.commit()