User Reference

• 1. Using the xGT System
  • 1.1. Installing the Client
    • 1.1.1. Installing from PyPi
    • 1.1.2. Installing from a Distribution Tarball
    • 1.1.3. Recommended Packages
    • 1.1.4. Verifying Installation
  • 1.2. Connecting to a Server
    • 1.2.1. Use SSH Tunneling
    • 1.2.2. Connect Via SSL-encrypted Network Connection
    • 1.2.3. Connecting to an Open Port
    • 1.2.4. User Authentication
  • 1.3. Using the Python Library
    • 1.3.1. Multiprocessing
  • 1.4. Driving from a Jupyter Notebook
    • 1.4.1. Useful Notebook Cells
  • 1.5. Capabilities of the Client
    • 1.5.1. Mixed-language Programming
• 2. Data Analytics
  • 2.1. Graph Thinking
    • 2.1.1. Introduction
    • 2.1.2. Graph Model
    • 2.1.3. Graph Image
    • 2.1.4. Setting up the Graph Model in xGT
    • 2.1.5. Looking for Interesting Patterns
    • 2.1.6. Concluding Remarks
    • 2.1.7. Graph Thinking Jupyter Notebook
  • 2.2. Frames and Namespaces
    • 2.2.1. Types of Frames
    • 2.2.2. Namespaces
    • 2.2.3. Access Control
  • 2.3. Data Types and Operators
    • 2.3.1. Scalar Data Types
    • 2.3.2. Composite Data Types
    • 2.3.3. Operators
  • 2.4. Frame Management
    • 2.4.1. Direct Frame Creation
    • 2.4.2. Implicit Frame Creation
    • 2.4.3. Retrieving Frames
    • 2.4.4. Dropping Frames
    • 2.4.5. Modifying Frame Columns
  • 2.5. Data Movement
    • 2.5.1. Getting Data into xGT
    • 2.5.2. Getting Data out of xGT
    • 2.5.3. Performance Considerations
    • 2.5.4. S3 Credentials
    • 2.5.5. Arrow Flight Server Endpoint
  • 2.6. Job Management
    • 2.6.1. Job Object
    • 2.6.2. Storing Temporary Query Results in Jobs
    • 2.6.3. Job History
  • 2.7. The Trovares Query Language (TQL)
  • 2.8. TQL Structure
    • 2.8.1. Putting It All Together
    • 2.8.2. Non-linear Patterns
    • 2.8.3. Variable-length Edge Traversal
    • 2.8.4. Multiple Edge Frame Traversal
    • 2.8.5. Path Variable Capture
  • 2.9. Constraints
    • 2.9.1. Pattern Filters
    • 2.9.2. Functions
    • 2.9.3. Temporal Components
    • 2.9.4. Geospatial Components
    • 2.9.5. CASE Expressions
    • 2.9.6. Cypher Parameters
  • 2.10. Property Extraction from Multiple Candidate Frames
    • 2.10.1. Limitations on Multiple Frame Property Extraction
  • 2.11. List Clauses / Expressions
    • 2.11.1. UNWIND Clause
    • 2.11.2. List Comprehension
  • 2.12. CALL Clause
    • 2.12.1. Whole Graph Algorithms
    • 2.12.2. Executing Algorithms on a Filtered Graph
  • 2.13. Modifications, Additions and Deletions
    • 2.13.1. Property Modifications
    • 2.13.2. Topology Additions
    • 2.13.3. Topology Deletions
    • 2.13.4. Row Additions and Deletions from Table Frames
    • 2.13.5. Visibility of Changes
  • 2.14. Query Results
    • 2.14.1. Describing the Query Results
    • 2.14.2. Modifying the Results
    • 2.14.3. Where the Results Are Placed
    • 2.14.4. Querying a Table Frame
    • 2.14.5. Multiple Query Parts
    • 2.14.6. Union Subqueries
    • 2.14.7. Optional Matches
    • 2.14.8. Returning Path Variables
  • 2.15. Row Access Control in Queries
  • 2.16. TQL for Cypher Users
    • 2.16.1. TQL Queries
    • 2.16.2. Query Examples
    • 2.16.3. Cypher Limitations
  • 2.17. Access Control
    • 2.17.1. Security Labels
    • 2.17.2. Frame Access Control
    • 2.17.3. Row Access Control
    • 2.17.4. Additional Rules
  • 2.18. Transactions
    • 2.18.1. Transaction Basics
    • 2.18.2. Transactions in Python
    • 2.18.3. Loading and Saving Data
    • 2.18.4. Modifying Data in Queries
    • 2.18.5. Background Statistics Collection
    • 2.18.6. Implicit Frame Creation
  • 2.19. Query Optimization
    • 2.19.1. Checking the Status of Statistics Collection
  • 2.20. TQL Fragments
    • 2.20.1. Input TQL Fragments
    • 2.20.2. Output TQL Fragments
    • 2.20.3. Bound Variables
    • 2.20.4. Interaction with Different Data Sources
    • 2.20.5. Requirements for Output Columns
    • 2.20.6. Putting It All Together
    • 2.20.7. Interaction with Different Data Targets
  • 2.21. Frame Row References (Row IDs)
    • 2.21.1. Row IDs in Python
    • 2.21.2. Lifetime and Validity of Row IDs
• 3. Useful Recipes
  • 3.1. Wrappers to the Python API
    • 3.1.1. Frame Drop
    • 3.1.2. Run Query
  • 3.2. Analytics Idioms
    • 3.2.1. Compute Column Statistics
    • 3.2.2. Compute a Column Histogram
    • 3.2.3. Generic Frame-type Idiom
  • 3.3. Data Management
    • 3.3.1. Interaction with Background Statistics Collection
• 4. Code Samples
• 5. Python API
  • 5.1. Main Features
    • 5.1.1. Data Loading
    • 5.1.2. Query Processing
    • 5.1.3. Example Script
  • 5.2. General
    • 5.2.1. xgt.Connection
    • 5.2.2. xgt.NoAuth
    • 5.2.3. xgt.BasicAuth
    • 5.2.4. xgt.KerberosAuth
    • 5.2.5. xgt.PKIAuth
    • 5.2.6. xgt.Job
    • 5.2.7. xgt.RowID
  • 5.3. Frames
    • 5.3.1. xgt.VertexFrame
    • 5.3.2. xgt.EdgeFrame
    • 5.3.3. xgt.TableFrame
  • 5.4. Exceptions
    • 5.4.1. xgt.XgtError
    • 5.4.2. xgt.XgtSecurityError
    • 5.4.3. xgt.XgtArithmeticError
    • 5.4.4. xgt.XgtConnectionError
    • 5.4.5. xgt.XgtFrameDependencyError
    • 5.4.6. xgt.XgtInternalError
    • 5.4.7. xgt.XgtIOError
    • 5.4.8. xgt.XgtNameError
    • 5.4.9. xgt.XgtNotImplemented
    • 5.4.10. xgt.XgtServerMemoryError
    • 5.4.11. xgt.XgtSyntaxError
    • 5.4.12. xgt.XgtTransactionError
    • 5.4.13. xgt.XgtTypeError
    • 5.4.14. xgt.XgtValueError
  • 5.5. Admin Module
• 6. Appendices
  • 6.1. Exhaustive List of LM-X Error Messages