Module neug.session

Session Objects

class Session()

Session is a class that connects to the NeuG server. User could use it just like a normal NeuG Connection, while it is actually a session that connects to the NeuG server.

A NeuG Server could be started with Database::serve() method, and it will listen to the specified endpoint.

 
    >>> from neug import Database
    >>> db = Database("/tmp/test.db", mode="w")
    >>> db.serve(port = 10000, host = "localhost")
 

And on another python shell, user could connect to the NeuG server with the following code:

 
    >>> from neug import Session
    >>> sess = Session('http://localhost:10000', timeout='10s')
    >>> sess.execute('MATCH(n) return count(n)')
 

The query will be sent to the NeuG http server, and the result will be returned as a response. The session will automatically handle the connection and disconnection to the server.

To stop the NeuG server, user could send terminal signal to the process. To close the session, user could call the close() method.

open

@staticmethod
def open(endpoint: str = "http://localhost:10000",
         timeout: str = "10s",
         num_threads: int = 1)

Open a session with the given endpoint and timeout.

Arguments:

• endpoint: The endpoint URL for the session.
• timeout: The timeout duration for the session.

Returns:

An instance of the Session class.

close

def close()

Close the session. This method is a placeholder for any cleanup operations. Currently, it does not perform any specific actions.

execute

def execute(query: str,
            access_mode: str = "",
            parameters: dict = None) -> QueryResult

Execute a query on the NeuG server.

Arguments:

• query: The query string to be executed.
• access_mode: The access mode for the query. Supported modes are:
• read or r: Read-only queries
• insert or i: Insert-only operations
• update or u: Update/delete operations (default)
• schema or s: Schema modification operations
• parameters: Optional dict of query parameters.

Returns:

The result of the query execution.

service_status

def service_status()

Get the service status of the NeuG server.

Returns:

The status of the NeuG server.

get_schema

def get_schema()

Get the schema of the NeuG database.

Returns:

The schema of the NeuG database.

timeout

@property
def timeout()

Get the timeout duration for the session, in seconds.