Storing¶

This notebook demonstrates Storing features. Storing allows users to persist and manage Resources in the configured store.

In [25]:

from kgforge.core import KnowledgeGraphForge

A configuration file is needed in order to create a KnowledgeGraphForge session. A configuration can be generated using the notebook 00-Initialization.ipynb.

In [26]:

forge = KnowledgeGraphForge("../../configurations/forge.yml")

Imports¶

In [27]:

from kgforge.core import Resource

Registration¶

resources¶

In [28]:

jane = Resource(type="Person", name="Jane Doe")

In [29]:

association = Resource(type="Association", agent=jane)
print(association)

{
    type: Association
    agent:
    {
        type: Person
        name: Jane Doe
    }
}

In [30]:

forge.register(association)

<action> _register_one
<succeeded> True

In [31]:

association._synchronized

Out[31]:

True

In [32]:

association._last_action

Out[32]:

Action(error=None, message=None, operation='_register_one', succeeded=True)

In [33]:

association._store_metadata

Out[33]:

{'id': 'https://sandbox.bluebrainnexus.io/v1/resources/github-users/crisely09/_/55be8922-befa-40a1-a1fe-056c0a787e1f',
 '_constrainedBy': 'https://bluebrain.github.io/nexus/schemas/unconstrained.json',
 '_createdAt': '2024-05-31T13:25:28.690Z',
 '_createdBy': 'https://sandbox.bluebrainnexus.io/v1/realms/github/users/crisely09',
 '_deprecated': False,
 '_incoming': 'https://sandbox.bluebrainnexus.io/v1/resources/github-users/crisely09/_/https:%2F%2Fsandbox.bluebrainnexus.io%2Fv1%2Fresources%2Fgithub-users%2Fcrisely09%2F_%2F55be8922-befa-40a1-a1fe-056c0a787e1f/incoming',
 '_outgoing': 'https://sandbox.bluebrainnexus.io/v1/resources/github-users/crisely09/_/https:%2F%2Fsandbox.bluebrainnexus.io%2Fv1%2Fresources%2Fgithub-users%2Fcrisely09%2F_%2F55be8922-befa-40a1-a1fe-056c0a787e1f/outgoing',
 '_project': 'https://sandbox.bluebrainnexus.io/v1/projects/github-users/crisely09',
 '_rev': 1,
 '_schemaProject': 'https://sandbox.bluebrainnexus.io/v1/projects/github-users/crisely09',
 '_self': 'https://sandbox.bluebrainnexus.io/v1/resources/github-users/crisely09/_/https:%2F%2Fsandbox.bluebrainnexus.io%2Fv1%2Fresources%2Fgithub-users%2Fcrisely09%2F_%2F55be8922-befa-40a1-a1fe-056c0a787e1f',
 '_updatedAt': '2024-05-31T13:25:28.690Z',
 '_updatedBy': 'https://sandbox.bluebrainnexus.io/v1/realms/github/users/crisely09'}

automatic status update¶

In [34]:

john = Resource(type="Person", name="John Smith")

In [35]:

association.agent = john

In [36]:

association._synchronized # _synchronized becomes False whenever the resource is updated

Out[36]:

False

error handling¶

In [37]:

persons = [jane, john]

In [38]:

forge.register(jane)

<action> _register_one
<succeeded> False
<error> RegistrationError: resource should not be synchronized

In [39]:

forge.register(persons) # it is not allowed to register an already registered resource without local change

<count> 2
<action> _register_many
<succeeded> True

In [40]:

jane._synchronized

Out[40]:

True

In [41]:

john._synchronized

Out[41]:

True

files¶

Note: DemoStore doesn't implement file operations yet. Please use another store for this section.

In [42]:

distribution = forge.attach("../../data/persons.csv")

In [43]:

jane = Resource(type="Person", name="Jane Doe", distribution=distribution)

In [44]:

forge.register(jane)

<action> _register_one
<succeeded> True

custom content type¶

In [45]:

distribution = forge.attach("../../data/my_data.xwz", content_type="application/xwz")

In [46]:

john = Resource(type="Person", name="John Smith", distribution=distribution)
print(john)

{
    type: Person
    distribution: LazyAction(operation=Store.upload, args=['../../data/my_data.xwz', 'application/xwz', <kgforge.core.forge.KnowledgeGraphForge object at 0x7fd2181ed790>])
    name: John Smith
}

In [47]:

forge.register(john)

<action> _register_one
<succeeded> True

Updating¶

In [48]:

jane = Resource(type="Person", name="Jane Doe")

In [49]:

association = Resource(type="Association", agent=jane)

In [50]:

forge.register(association)

<action> _register_one
<succeeded> True

In [51]:

try:
    # DemoStore
    print(association._store_metadata.version)
except:
    # BlueBrainNexus
    print(association._store_metadata._rev)

In [52]:

john = Resource(type="Person", name="John Smith")

In [53]:

association.agent = john

In [54]:

forge.update(association)

<action> _update_one
<succeeded> True

In [55]:

association.agent._synchronized

Out[55]:

True

In [56]:

try:
    # DemoStore
    print(association._store_metadata.version)
except:
    # BlueBrainNexus
    print(association._store_metadata._rev)

Deprecation¶

In [57]:

jane = Resource(type="Person", name="Jane Doe")
print(jane)

{
    type: Person
    name: Jane Doe
}

In [58]:

forge.register(jane)

<action> _register_one
<succeeded> True

In [59]:

jane._synchronized

Out[59]:

True

In [60]:

try:
    # DemoStore
    print(jane._store_metadata.deprecated)
except:
    # BlueBrainNexus
    print(jane._store_metadata._deprecated)

False

In [61]:

forge.deprecate(jane)

<action> _deprecate_one
<succeeded> True

In [62]:

try:
    # DemoStore
    print(jane._store_metadata.deprecated)
except:
    # BlueBrainNexus
    print(jane._store_metadata._deprecated)

True