This wiki has undergone a migration to Confluence found Here

Difference between revisions of "FHIR Package Cache"

From HL7Wiki
Jump to navigation Jump to search
(Migrate Content to Confluence/Added Forward Link)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Package Cache =
+
Content on this page has been migrated to Confluence here: https://confluence.hl7.org/display/FHIR/FHIR+Package+Cache
 +
 
 +
 
 +
'''NOTE: This page is under the management of FHIR Infrastructure.  All substantive changes to this specification require formal review and approval by the FHIR-I Working Group.'''
 +
 
 +
=Package Cache=
  
 
Each system has a global package cache that stores the packages known to that system. This cache is shared between tools for efficiency. Authors of tools that work with FHIR packages are encouraged to follow this specification for the convenience of users.  
 
Each system has a global package cache that stores the packages known to that system. This cache is shared between tools for efficiency. Authors of tools that work with FHIR packages are encouraged to follow this specification for the convenience of users.  
Line 5: Line 10:
 
The package cache keeps the uncompressed content of all installed packages. Different versions of a package are installed side-by-side, and are individually resolvable. A Fhir package client should use the global package cache, but may keep a local cache in a working folder instead. The global package cache makes sure that each packages is installed only once on the computer
 
The package cache keeps the uncompressed content of all installed packages. Different versions of a package are installed side-by-side, and are individually resolvable. A Fhir package client should use the global package cache, but may keep a local cache in a working folder instead. The global package cache makes sure that each packages is installed only once on the computer
  
= Location =
+
=Location=
  
 
The location differs per operating system.
 
The location differs per operating system.
Line 11: Line 16:
 
Location of the global package cache:
 
Location of the global package cache:
  
- Windows: c:\users\<username>\.fhir\packages
+
*Windows: c:\users\<username>\.fhir\packages
- Linux: /~/.fhir/packages
+
*Unix/Linux: /~/.fhir/packages
  
 
For system services (daemons):
 
For system services (daemons):
  
- Windows: c:\ProgramData\.fhir\packages
+
*Windows: c:\ProgramData\.fhir\packages
- Linux: /var/lib/.fhir/packages
+
*Unix/Linux: /var/lib/.fhir/packages
  
 
The package cache root folder contains a folder per package where the folder name is the package name, a dash and the package version.  
 
The package cache root folder contains a folder per package where the folder name is the package name, a dash and the package version.  
Line 23: Line 28:
 
   hl7.fhir.us.core#0.1.1
 
   hl7.fhir.us.core#0.1.1
 
   
 
   
In addition, the package cache root folder contains a file "packages.ini".
+
Note: package names are not allowed to contain the character "#"
 
 
Note: package name are not allowed to contain the character "#"
 
  
= packages.ini =
+
=Folder contents=
  
The packages.ini file contains the following content:
+
In each package folder the package is unzipped as it is. The contents of the folder are the unpacked version of the GZipped tarball and SHALL otherwise conform to the requirements for the [[FHIR NPM Package Spec]].
  
[cache]
+
There is at least one folder called "package", in which all the content of the package is found, including the package manifest. Other folders with other uses may exist if found in the source package.
version=2
 
  
[urls]
+
=Recursion=
packageid=canonical
 
 
 
details:
 
* cache: version = 2 - indicates that the contents of the package cache conform to this specification. Applications using the package cache SHALL check this value and shall refuse to use the cache if the value is != 1
 
* urls: a list of mappings between package ids and canonical URLs - shared between applications to save a user resolving the same canonical URL repeatedly
 
 
 
= Folder contents =
 
 
 
In each package folder there is one folder called "package", in which all the content of the package is found, including the package manifest. The contents of the folder are the unpacked version of the GZipped tarball and SHALL otherwise conform to the requirements for the [[FHIR NPM Package Spec]]
 
 
 
= Recursion =
 
  
 
A package client must resolve package dependencies recursively, but keep the package cache flat. An installed package should itself not contain any dependencies. All packages are installed on the same level.
 
A package client must resolve package dependencies recursively, but keep the package cache flat. An installed package should itself not contain any dependencies. All packages are installed on the same level.
  
Example:
+
=Package .index.json files=
  us.core.valuesets#2.0.0
+
Tools that extract and populate the package cache are repsonsible for ensuring that the .index.json files exist. If the package comes with a .index.json file, the tool does not need to rebuild it, though it may choose to do so.
 
 
= Past Versions =
 
 
 
[cache]
 
version=1
 
 
 
Cache version #1 specified to use "-" as the version separator for package/version in the cache, but "-" is allowed in both package name, and version, so this was not maintainable. Use "#" instead
 

Latest revision as of 19:50, 30 October 2019

Content on this page has been migrated to Confluence here: https://confluence.hl7.org/display/FHIR/FHIR+Package+Cache


NOTE: This page is under the management of FHIR Infrastructure. All substantive changes to this specification require formal review and approval by the FHIR-I Working Group.

Package Cache

Each system has a global package cache that stores the packages known to that system. This cache is shared between tools for efficiency. Authors of tools that work with FHIR packages are encouraged to follow this specification for the convenience of users.

The package cache keeps the uncompressed content of all installed packages. Different versions of a package are installed side-by-side, and are individually resolvable. A Fhir package client should use the global package cache, but may keep a local cache in a working folder instead. The global package cache makes sure that each packages is installed only once on the computer

Location

The location differs per operating system.

Location of the global package cache:

  • Windows: c:\users\<username>\.fhir\packages
  • Unix/Linux: /~/.fhir/packages

For system services (daemons):

  • Windows: c:\ProgramData\.fhir\packages
  • Unix/Linux: /var/lib/.fhir/packages

The package cache root folder contains a folder per package where the folder name is the package name, a dash and the package version.

 hl7.fhir.us.core#0.1.1

Note: package names are not allowed to contain the character "#"

Folder contents

In each package folder the package is unzipped as it is. The contents of the folder are the unpacked version of the GZipped tarball and SHALL otherwise conform to the requirements for the FHIR NPM Package Spec.

There is at least one folder called "package", in which all the content of the package is found, including the package manifest. Other folders with other uses may exist if found in the source package.

Recursion

A package client must resolve package dependencies recursively, but keep the package cache flat. An installed package should itself not contain any dependencies. All packages are installed on the same level.

Package .index.json files

Tools that extract and populate the package cache are repsonsible for ensuring that the .index.json files exist. If the package comes with a .index.json file, the tool does not need to rebuild it, though it may choose to do so.