Session Export

Sessions can be exported to local SSN2 files using the SQLRace API and the SessionManager object.

For instance, a SQLRace Session stored in a SQLRace Database can generate a local SSN2 or SSNDB session file.

SessionManager

The SessionManager class provides functionality to export sessions into local SSN2 or SSNDB files using the SQLRace API.

Export Process Overview

1. The session is first exported into a MESL.SqlRace.Common.FragmentedMemoryStream object using the ExportSession method.
2. This FragmentedMemoryStream contains all the necessary configuration and data required to reconstruct the session.
3. The resulting stream can then be used with the ImportSession method to generate and populate the session in its final form.

Key Methods

SessionManager.ExportSession()

SessionManager.ImportSession()

Important: Do not use ExportSession alone to create a session file

Calling SessionManager.ExportSession with a file path will generate an SSN2 session file, but this file will be unreadable by ATLAS and ignored by the SQLRace API.

To create a valid and usable session file:

1. Export the session into a FragmentedMemoryStream using ExportSession.
2. Then use ImportSession to properly populate and finalize the session file.

Example SQLRace Session to SSN2

Basic example that shows how to export to SSN2 from a SQLRace Database session.

Load a session from a SQLRace Database:

C#PythonMATLAB

class Program
{
    static void Main()
    {
        string connectionStringSQLRACE = @"Data Source=SERVER_NAME\LOCAL;Initial Catalog=SQLRACE01;Integrated Security=True";

        SessionManager sessionManager = SessionManager.CreateSessionManager();

        SessionState sessionState = SessionState.Historical;

        var clientSessions = sessionManager.FindBySessionState(sessionState, connectionStringSQLRACE);
        var session = clientSessions[5];

        var clientSession = sessionManager.Load(session.Key, connectionStringSQLRACE);
        var loadedSession = clientSession.Session;

        loadedSession.LoadConfiguration();

        Console.WriteLine($"Session loaded: {loadedSession.Identifier}");

        clientSession.Close();
        clientSession.Dispose();
    }
}

    connectionStringSQLRACE = f"Data Source=SERVER_NAME\LOCAL;Initial Catalog=SQLRACE01;Integrated Security=True"
    sessionManager = SessionManager.CreateSessionManager()
    available_states = {"Created": SessionState.Created,
                        "Exporting": SessionState.Exporting,
                        "Historical": SessionState.Historical,
                        "Live": SessionState.Live,
                        "LiveNotInServer": SessionState.LiveNotInServer,
                        "Indexed": SessionState.Indexed}

    sessionState = available_states["Historical"]
    clientSession_filter_state = sessionManager.FindBySessionState(sessionState, connectionStringSQLRACE)
    session = clientSession_filter_state[5]
    clientSession = sessionManager.Load(session.Key, connectionStringSQLRACE)
    session = clientSession.Session
    session.LoadConfiguration()
    print(f"Session loaded: {session.Identifier}")
    clientSession.Close()
    clientSession.Dispose()

    connectionStringSQLRACE = 'Data Source=MCLA-525Q374\LOCAL;Initial Catalog=SQLRACE01;Integrated Security=True';

    sessionManager = NET.invokeGenericMethod('MESL.SqlRace.Domain.SessionManager', 'CreateSessionManager', {});

    % Define session state
    sessionState = MESL.SqlRace.Domain.SessionState.Historical;

    % Find sessions by state
    clientSessions = sessionManager.FindBySessionState(sessionState, connectionStringSQLRACE);

    % Select the 6th session (MATLAB is 1-based)
    session = clientSessions.Get(6);

    % Load the session
    clientSession = sessionManager.Load(session.Key, connectionStringSQLRACE);
    loadedSession = clientSession.Session;

    % Load configuration
    loadedSession.LoadConfiguration();

    % Display session identifier
    disp(['Session loaded: ', char(loadedSession.Identifier)]);

    % Close and dispose
    clientSession.Close();
    clientSession.Dispose();

Use the SessionManager to store the session into memory and then import the session into a local file using the ImportSession method.

C#PythonMATLAB

    // Session key from the original session
    var sessionkey = session.Key;
    // Create the connection string to the SSN2 
    var localSsn2ConncetionString = $"DbEngine=SQLite;Data Source={ssn2FileName}";

    // Export/store session from memory stream
    memoryStream = sessionManager.ExportSession(sessionKey, connectionString);
    //  Import session from memory stream
    sessionManager.ImportSession(localSsn2ConncetionString, memoryStream, sessionKey);

    # Session key from the original session
    sessionkey = session.Key

    # Define file path where to export the session
    filePath = r"C:\ssn2\ExportSession.ssn2"
    # Create the connection string to the SSN2
    localSsn2ConncetionString = f"DbEngine=SQLite;Data Source={filePath}"

    # Export/store session from memory stream
    memoryStream = sessionManager.ExportSession(sessionkey, connectionStringSQLRACE)
    # Import session from memory stream
    sessionManager.ImportSession(localSsn2ConncetionString, memoryStream, SessionKey.NewKey())

``` matlab % Session key from the original session sessionkey = session.Key;

% Define file path where to export the session
filePath = 'C:\ssn2\ExportSession.ssn2';

% Create local connection string
localSsn2ConnectionString = sprintf('DbEngine=SQLite;Data Source=%s', filePath);

% Export/store session to memory stream
memoryStream = sessionManager.ExportSession(sessionkey, connectionStringSQLRACE);

% Import session from memory stream
sessionManager.ImportSession(localSsn2ConnectionString, memoryStream, SessionKey.NewKey());