|
2 | 2 | Release Notes |
3 | 3 | ============= |
4 | 4 |
|
5 | | -This release adds new features and enhancements to Nexus Forge as well as bug fixes. |
6 | | - |
7 | | -New Features |
8 | | -============ |
9 | | - |
10 | | -Resolving |
11 | | ---------- |
12 | | - |
13 | | -* Added ontology resource resolving based on skos:prefLabel and skos:altLabel in addition to label and skos:notation. `#245 <https://github.com/BlueBrain/nexus-forge/pull/245>`__ (|Binder_Resolving| to try it) |
14 | | - |
15 | | -Modeling |
16 | | --------- |
17 | | - |
18 | | -* Add support for validation against a schema. `#217 <https://github.com/BlueBrain/nexus-forge/pull/217>`__ (|Binder_Modeling| to try it) |
19 | | - |
20 | | -.. code-block:: python |
21 | | -
|
22 | | - from kgforge.core import KnowledgeGraphForge |
23 | | - # see https://github.com/BlueBrain/nexus-forge/blob/master/examples/notebooks/use-cases/prod-forge-nexus.yml for a full forge config example. |
24 | | - forge = KnowledgeGraphForge(configuration="./config.yml", **kwargs) |
25 | | - person = Resource(type="Person", name="Jane Doe") |
26 | | - # By default the schema associated with the resource type is picked for validation. A different type can be set using the type_ argument. |
27 | | - forge.validate(person, type_="Agent") |
| 5 | +This release introduces new enhancements to Nexus Forge. |
28 | 6 |
|
29 | 7 |
|
30 | 8 | Enhancements |
31 | 9 | ============ |
32 | 10 |
|
33 | | -Querying |
34 | | --------- |
35 | | - |
36 | | -|Binder_Querying| to try the querying enhancements. |
37 | | - |
38 | | -* Added support for searching using filters (except when Paths syntax is used) from _store_metadata properties (i.e _createdAt, _updatedAt,...) `#224 <https://github.com/BlueBrain/nexus-forge/pull/224>`__ `#240 <https://github.com/BlueBrain/nexus-forge/pull/240>`__ (issue `#209 <https://github.com/BlueBrain/nexus-forge/pull/209>`__) |
39 | | -* Added support for searching using datetime filters which can be specify as string suffixed with `^^xsd:dateTime` `#224 <https://github.com/BlueBrain/nexus-forge/pull/224>`__ |
40 | | - |
41 | | -.. code-block:: python |
| 11 | +Storing |
| 12 | +------- |
42 | 13 |
|
43 | | - from kgforge.core import KnowledgeGraphForge |
44 | | - # see https://github.com/BlueBrain/nexus-forge/blob/master/examples/notebooks/use-cases/prod-forge-nexus.yml for a full forge config example. |
45 | | - forge = KnowledgeGraphForge(configuration="./config.yml", **kwargs) |
46 | | - filters = { |
47 | | - "type": "Dataset", |
48 | | - "_createdAt":'"2022-04-12T21:29:14.410Z"^^xsd:dateTime' |
49 | | - } |
50 | | - forge.search(filters) |
| 14 | +|Binder_Storing| to try the enhancements. |
51 | 15 |
|
52 | | -
|
53 | | -* Added support for disabling SPARQL rewriting when a correct SPARQL is provided `#224 <https://github.com/BlueBrain/nexus-forge/pull/224>`__ (issue `#218 <https://github.com/BlueBrain/nexus-forge/pull/218>`__) |
54 | | -* Inline query limit/offset arguments are now superseded by limit/offset provided as argument for `forge.search()` `#224 <https://github.com/BlueBrain/nexus-forge/pull/224>`__ (issue `#189 <https://github.com/BlueBrain/nexus-forge/pull/189>`__) |
55 | | -* Added support for `IN` SPARQL clause when rewriting SPARQL queries in `forge.search()` `#240 <https://github.com/BlueBrain/nexus-forge/pull/240>`__ (issue `#242 <https://github.com/BlueBrain/nexus-forge/pull/242>`__) |
56 | | -* Using filters as argument when calling `forge.search(*filters, **params)` now raises an exception `#240 <https://github.com/BlueBrain/nexus-forge/pull/240>`__ |
57 | | -* When using BlueBrainNexusStore, `forge.retrieve()` and `forge.search()` now get the `original registered JSON payload <https://bluebrainnexus.io/docs/delta/api/resources-api.html#fetch-original-payload>`__ to avoid any JSON transformation `#232 <https://github.com/BlueBrain/nexus-forge/pull/232>`__ |
58 | | -* `forge.search()` returns resources at the exact revision they are stored in the configured searchendpoint and no longer at the latest revision. As a consequence search results are no longer `_sychronized` `#232 <https://github.com/BlueBrain/nexus-forge/pull/232>`__ |
59 | | -* `_last_action` property is now added to resources obtained from `forge.retrieve()` `#232 <https://github.com/BlueBrain/nexus-forge/pull/232>`__ |
60 | | -* Added the property distribution.atLocation.store.type and distribution.atLocation.store.type._rev to BlueBrainNexusStore file metadata mapping file `#232 <https://github.com/BlueBrain/nexus-forge/pull/232>`__ |
61 | | -* When using BlueBrainNexusStore, it is possible to set (in the forge config file) GET params when calling `forge.retrieve() `#232 <https://github.com/BlueBrain/nexus-forge/pull/232>`__ |
62 | | - |
63 | | -Converting |
64 | | ----------- |
65 | | - |
66 | | -|Binder_JSON-LD-IO| to try the JSON-LD enhancements. |
67 | | - |
68 | | -* `forge.as_jsonld(r, form="expanded")` now outputs expanded JSON-LD with @value added for literals. `#244 <https://github.com/BlueBrain/nexus-forge/pull/244>`__ |
69 | | -* `forge.as_jsonld(r, form="compacted")` keeps unchanged JSON null values and arrays. The param `array_as_set` is no longer needed and is thus removed along with the `na` argument `#244 <https://github.com/BlueBrain/nexus-forge/pull/244>`__ |
| 16 | +* Synchronize nested resources of a given resources when calling `forge.register(resource)` `#269 <https://github.com/BlueBrain/nexus-forge/pull/269>`__ (issue `#211 <https://github.com/BlueBrain/nexus-forge/issues/211>`__) |
70 | 17 |
|
71 | 18 |
|
72 | 19 | Resolving |
73 | 20 | --------- |
74 | 21 |
|
75 | 22 | |Binder_Resolving| to try the resolving enhancements. |
76 | 23 |
|
77 | | -* Added `searchendpoints` config in the `forge config Resolvers section <https://github.com/BlueBrain/nexus-forge/blob/v0.7.1/examples/notebooks/use-cases/prod-forge-nexus.yml#L30>`__ `#226 <https://github.com/BlueBrain/nexus-forge/pull/226>`__ |
| 24 | +* Added ResolvingStrategy.EXACT_CASEINSENSITIVE_MATCH as a new case-insensitive exact match resolving strategy `#275 <https://github.com/BlueBrain/nexus-forge/pull/275>`__ `#277 <https://github.com/BlueBrain/nexus-forge/pull/277>`__ |
78 | 25 |
|
79 | 26 |
|
80 | | -Bug Fixes |
81 | | -========= |
82 | 27 |
|
83 | | -* Added an identifier and the forge model configured JSON-LD context to resources obtained from an ElasticSearch query `#238 <https://github.com/BlueBrain/nexus-forge/pull/238>`__ (issue `#230 <https://github.com/BlueBrain/nexus-forge/pull/230>`__) (|Binder_Querying| to try it) |
84 | | -* Fixed failing SPARQL query rewriting when a used JSON-LD context term does not have `@id` `#231 <https://github.com/BlueBrain/nexus-forge/pull/231>`__ |
| 28 | +Formatting |
| 29 | +---------- |
| 30 | + |
| 31 | +|Binder_Formatting| to try the enhancements. |
| 32 | + |
| 33 | +* Added a new identifier formatter for BBP Nexus Store deployment `#278 <https://github.com/BlueBrain/nexus-forge/pull/278>`__ |
| 34 | + |
85 | 35 |
|
86 | 36 | Changelog |
87 | 37 | ========= |
88 | 38 |
|
89 | | -`Full changelog <https://github.com/BlueBrain/nexus-forge/compare/v0.7.0...v0.7.1>`__ |
| 39 | +`Full changelog <https://github.com/BlueBrain/nexus-forge/compare/v0.7.1...v0.8.0>`__ |
90 | 40 |
|
91 | 41 | .. |Binder_Resolving| image:: https://mybinder.org/badge_logo.svg |
92 | 42 | :alt: Binder_Querying |
93 | | - :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.7.1?filepath=examples%2Fnotebooks%2Fgetting-started%2F09%20-%20Resolving.ipynb |
94 | | - |
95 | | -.. |Binder_Modeling| image:: https://mybinder.org/badge_logo.svg |
96 | | - :alt: Binder_Modeling |
97 | | - :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.7.1?filepath=examples%2Fnotebooks%2Fgetting-started%2F09%20-%20Modeling.ipynb |
| 43 | + :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.8.0?filepath=examples%2Fnotebooks%2Fgetting-started%2F09%20-%20Resolving.ipynb |
98 | 44 |
|
99 | | -.. |Binder_JSON-LD-IO| image:: https://mybinder.org/badge_logo.svg |
100 | | - :alt: Binder_JSON-LD-IO |
101 | | - :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.7.1?filepath=examples%2Fnotebooks%2Fgetting-started%2F13%20-%20JSON-LD%20IO.ipynb |
| 45 | +.. |Binder_Storing| image:: https://mybinder.org/badge_logo.svg |
| 46 | + :alt: Binder_Storing |
| 47 | + :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.8.0?filepath=examples%2Fnotebooks%2Fgetting-started%2F03%20-%20Storing.ipynb |
102 | 48 |
|
103 | | -.. |Binder_Querying| image:: https://mybinder.org/badge_logo.svg |
104 | | - :alt: Binder_Querying |
105 | | - :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.7.1?filepath=examples%2Fnotebooks%2Fgetting-started%2F04%20-%20Querying.ipynb |
| 49 | +.. |Binder_Formatting| image:: https://mybinder.org/badge_logo.svg |
| 50 | + :alt: Binder_Formatting |
| 51 | + :target: https://mybinder.org/v2/gh/BlueBrain/nexus-forge/v0.8.0?filepath=examples%2Fnotebooks%2Fgetting-started%2F08%20-%20Formatting.ipynb |
0 commit comments