pystardog Logo

User Guide:

  • Getting Started
    • What is it?
    • Installation
    • Quick Examples
      • Stardog Server (Local/Remote Endpoint)
      • Stardog Cloud (Voicebox)

Modules:

  • Stardog
    • API Reference
      • stardog.connection
        • CommitResult
          • CommitResult.added
          • CommitResult.removed
        • Connection
          • Connection.__init__()
          • Connection.add()
          • Connection.ask()
          • Connection.begin()
          • Connection.clear()
          • Connection.close()
          • Connection.commit()
          • Connection.docs()
          • Connection.explain()
          • Connection.explain_inconsistency()
          • Connection.explain_inference()
          • Connection.export()
          • Connection.graph()
          • Connection.graphql()
          • Connection.icv()
          • Connection.is_consistent()
          • Connection.paths()
          • Connection.remove()
          • Connection.rollback()
          • Connection.select()
          • Connection.size()
          • Connection.update()
        • Docs
          • Docs.__init__()
          • Docs.add()
          • Docs.clear()
          • Docs.delete()
          • Docs.get()
          • Docs.size()
        • GraphQL
          • GraphQL.__init__()
          • GraphQL.add_schema()
          • GraphQL.clear_schemas()
          • GraphQL.query()
          • GraphQL.remove_schema()
          • GraphQL.schema()
          • GraphQL.schemas()
        • ICV
          • ICV.__init__()
          • ICV.add()
          • ICV.clear()
          • ICV.convert()
          • ICV.explain_violations()
          • ICV.is_valid()
          • ICV.list()
          • ICV.remove()
          • ICV.report()
      • stardog.admin
        • Admin
          • Admin.__init__()
          • Admin.alive()
          • Admin.backup_all()
          • Admin.cache()
          • Admin.cache_status()
          • Admin.cache_targets()
          • Admin.cached_graphs()
          • Admin.cached_queries()
          • Admin.cached_status()
          • Admin.clear_stored_queries()
          • Admin.cluster_coordinator_check()
          • Admin.cluster_info()
          • Admin.cluster_join()
          • Admin.cluster_list_standby_nodes()
          • Admin.cluster_revoke_standby_access()
          • Admin.cluster_shutdown()
          • Admin.cluster_start_readonly()
          • Admin.cluster_status()
          • Admin.cluster_stop_readonly()
          • Admin.database()
          • Admin.databases()
          • Admin.datasource()
          • Admin.datasources()
          • Admin.datasources_info()
          • Admin.get_all_metadata_properties()
          • Admin.get_prometheus_metrics()
          • Admin.get_server_metrics()
          • Admin.get_server_properties()
          • Admin.healthcheck()
          • Admin.import_file()
          • Admin.import_virtual_graph()
          • Admin.kill_query()
          • Admin.materialize_virtual_graph()
          • Admin.new_cache_target()
          • Admin.new_cached_graph()
          • Admin.new_cached_query()
          • Admin.new_database()
          • Admin.new_datasource()
          • Admin.new_role()
          • Admin.new_stored_query()
          • Admin.new_user()
          • Admin.new_virtual_graph()
          • Admin.queries()
          • Admin.query()
          • Admin.restore()
          • Admin.role()
          • Admin.roles()
          • Admin.shutdown()
          • Admin.standby_node_pause()
          • Admin.standby_node_pause_status()
          • Admin.stored_queries()
          • Admin.stored_query()
          • Admin.user()
          • Admin.users()
          • Admin.validate()
          • Admin.virtual_graph()
          • Admin.virtual_graphs()
        • Cache
          • Cache.__init__()
          • Cache.drop()
          • Cache.refresh()
          • Cache.status()
        • CacheTarget
          • CacheTarget.__init__()
          • CacheTarget.info()
          • CacheTarget.name
          • CacheTarget.orphan()
          • CacheTarget.remove()
        • DataSource
          • DataSource.__init__()
          • DataSource.available()
          • DataSource.delete()
          • DataSource.get_options()
          • DataSource.info()
          • DataSource.name
          • DataSource.online()
          • DataSource.refresh_count()
          • DataSource.refresh_metadata()
          • DataSource.share()
          • DataSource.update()
        • Database
          • Database.__init__()
          • Database.add_namespace()
          • Database.backup()
          • Database.copy()
          • Database.drop()
          • Database.get_all_options()
          • Database.get_options()
          • Database.import_namespaces()
          • Database.name
          • Database.namespaces()
          • Database.offline()
          • Database.online()
          • Database.optimize()
          • Database.remove_namespace()
          • Database.repair()
          • Database.set_options()
          • Database.verify()
        • Role
          • Role.__init__()
          • Role.add_permission()
          • Role.delete()
          • Role.name
          • Role.permissions()
          • Role.remove_permission()
          • Role.users()
        • StoredQuery
          • StoredQuery.__init__()
          • StoredQuery.creator
          • StoredQuery.database
          • StoredQuery.delete()
          • StoredQuery.description
          • StoredQuery.name
          • StoredQuery.query
          • StoredQuery.reasoning
          • StoredQuery.shared
          • StoredQuery.update()
        • User
          • User.__init__()
          • User.add_permission()
          • User.add_role()
          • User.delete()
          • User.effective_permissions()
          • User.is_enabled()
          • User.is_superuser()
          • User.name
          • User.permissions()
          • User.remove_permission()
          • User.remove_role()
          • User.roles()
          • User.set_enabled()
          • User.set_password()
          • User.set_roles()
        • VirtualGraph
          • VirtualGraph.__init__()
          • VirtualGraph.available()
          • VirtualGraph.delete()
          • VirtualGraph.get_database()
          • VirtualGraph.get_datasource()
          • VirtualGraph.info()
          • VirtualGraph.mappings()
          • VirtualGraph.mappings_string()
          • VirtualGraph.name
          • VirtualGraph.options()
          • VirtualGraph.update()
      • stardog.content
        • Content
        • File
          • File.__init__()
          • File.data()
        • ImportFile
          • ImportFile.__init__()
          • ImportFile.data()
        • ImportRaw
          • ImportRaw.__init__()
          • ImportRaw.data()
        • MappingFile
          • MappingFile.__init__()
          • MappingFile.data()
        • MappingRaw
          • MappingRaw.__init__()
          • MappingRaw.data()
        • Raw
          • Raw.__init__()
          • Raw.data()
        • URL
          • URL.__init__()
          • URL.data()
      • stardog.results
        • BindingSet
          • BindingSet.__init__()
          • BindingSet.get_raw()
          • BindingSet.raw
          • BindingSet.to_list()
          • BindingSet.variable_names
        • RDFTerm
          • RDFTerm.datatype
          • RDFTerm.lang
          • RDFTerm.type
          • RDFTerm.value
        • SPARQLQueryResults
          • SPARQLQueryResults.bindings
        • SPARQLQueryResultsHead
          • SPARQLQueryResultsHead.vars
        • SPARQLQueryResultsJSON
          • SPARQLQueryResultsJSON.head
          • SPARQLQueryResultsJSON.results
        • SelectQueryResult
          • SelectQueryResult.__init__()
          • SelectQueryResult.bindings
          • SelectQueryResult.is_empty
          • SelectQueryResult.raw
          • SelectQueryResult.variable_names
        • rdf_term_to_rdflib()
      • stardog.exceptions
        • StardogException
        • TransactionException
  • Stardog Cloud
    • Installation
    • Voicebox Integration
      • Synchronous usage
      • Asynchronous usage
      • Error Handling
    • API Reference
      • stardog.cloud.client
        • AsyncClient
          • AsyncClient.__init__()
          • AsyncClient.aclose()
          • AsyncClient.base_url
          • AsyncClient.voicebox_app()
        • BaseClient
          • BaseClient.base_url
          • BaseClient.voicebox_app()
        • Client
          • Client.__init__()
          • Client.base_url
          • Client.close()
          • Client.voicebox_app()
        • StardogCloudAPIEndpoints
          • StardogCloudAPIEndpoints.EU
          • StardogCloudAPIEndpoints.US
      • stardog.cloud.voicebox
        • VoiceboxAction
          • VoiceboxAction.label
          • VoiceboxAction.type
          • VoiceboxAction.value
        • VoiceboxAnswer
          • VoiceboxAnswer.actions
          • VoiceboxAnswer.content
          • VoiceboxAnswer.conversation_id
          • VoiceboxAnswer.message_id
          • VoiceboxAnswer.interpreted_question
          • VoiceboxAnswer.sparql_query
        • VoiceboxApp
          • VoiceboxApp.__init__()
          • VoiceboxApp.ask()
          • VoiceboxApp.async_ask()
          • VoiceboxApp.async_generate_query()
          • VoiceboxApp.async_settings()
          • VoiceboxApp.generate_query()
          • VoiceboxApp.settings()
        • VoiceboxAppSettings
          • VoiceboxAppSettings.database
          • VoiceboxAppSettings.model
          • VoiceboxAppSettings.name
          • VoiceboxAppSettings.named_graphs
          • VoiceboxAppSettings.reasoning
      • stardog.cloud.exceptions
        • BadRequestException
        • ForbiddenException
        • GatewayTimeoutException
        • InternalServerException
        • NotFoundException
        • RateLimitExceededException
        • StardogCloudException
          • StardogCloudException.__init__()
        • UnauthorizedException

Development:

  • Contributing
    • Making a Contribution
    • Development Setup
      • Running Tests
      • Formatting Your Code
      • Running Tests with Tox
      • Building Documentation
        • Autodoc Type Hints
        • Auto Build
      • Building and Publishing
pystardog
  • Search

© Copyright 2019-2025 Stardog Union.

Built with Sphinx using a theme provided by Read the Docs.