Fantoir-datasource - Revision history

Dereckson: /* Fetch */ Code update

2023-01-18T01:49:19Z

Fetch: Code update

← Older revision		Revision as of 01:49, 18 January 2023
Line 52:		Line 52:
	\| 0 \|\| Fetch operation succeeded		\| 0 \|\| Fetch operation succeeded
	\|-		\|-
	\| 2 \|\| Parsing arguments issue (not fetch specific)		\| 2 \|\| Parsing arguments issue (not fetch specific), or unzip format issue (fetch specific)
	\|-		\|-
	\| 4 \|\| FANTOIR file already exist and --overwrite not specified		\| 12 \|\| FANTOIR file already exist and --overwrite not specified
	\|-		\|-
	\| 8 \|\| Download issue, at filesystem or HTTP level, stderr will provide information for humans or store in a log		\| 16 \|\| Download issue, at filesystem or HTTP level, stderr will provide information for humans or store in a log
			\|-
			\| 32 \|\| unzip not found, you need to install unzip to decompress the archive
	\|-		\|-
	\| n \|\| Exit code from unzip command ([https://linux.die.net/man/1/unzip man 1 unzip])		\| n \|\| Exit code from unzip command ([https://linux.die.net/man/1/unzip man 1 unzip])

Dereckson: /* Recommended workflow */

2023-01-15T06:54:27Z

Recommended workflow

← Older revision		Revision as of 06:54, 15 January 2023
Line 15:		Line 15:

	It's possible to create a maintenance report for Wikidata during that import, using <code>fantoir-datasource wikidata -tc --maintenance-report</code>.		It's possible to create a maintenance report for Wikidata during that import, using <code>fantoir-datasource wikidata -tc --maintenance-report</code>.
			{{clear}}

	== Usage ==		== Usage ==

Dereckson: /* Database setup */

2023-01-15T06:53:52Z

Database setup

← Older revision		Revision as of 06:53, 15 January 2023
Line 2:		Line 2:

	== Database setup ==		== Database setup ==
			[[File:Database schema for fantoir-datasource.png\|thumb\|480px\|Database schema for fantoir-datasource]]
	The tool uses a PostgreSQL database to store FANTOIR, Wikidata and configuration data.		The tool uses a PostgreSQL database to store FANTOIR, Wikidata and configuration data.

Dereckson at 06:20, 15 January 2023

2023-01-15T06:20:31Z

@@ Line 1: / Line 1: @@
 The <code>fantoir-datasource</code> tool allows to import and manage FANTOIR datasource.
 == Usage ==
 <source>

Dereckson: Created page with "The `fantoir-datasource` tool allows to import and manage FANTOIR datasource. == Usage == $ fantoir-datasource help Import FANTOIR database into PostgreSQL Usage: fantoir-datasource Commands: fetch Fetch the last version of the FANTOIR file import Import from FANTOIR file generated by the DGFIP promote Promote an imported FANTOIR table as the current FANTOIR table to use wikidata Query Wikidata SPARQL end-point to enri..."

2023-01-15T06:09:41Z

Created page with "The <code>fantoir-datasource</code> tool allows to import and manage FANTOIR datasource. == Usage == <source> $ fantoir-datasource help Import FANTOIR database into PostgreSQL Usage: fantoir-datasource <COMMAND> Commands: fetch Fetch the last version of the FANTOIR file import Import from FANTOIR file generated by the DGFIP promote Promote an imported FANTOIR table as the current FANTOIR table to use wikidata Query Wikidata SPARQL end-point to enri..."

New page

The <code>fantoir-datasource</code> tool allows to import and manage FANTOIR datasource.

== Usage ==

<source>
$ fantoir-datasource help

Import FANTOIR database into PostgreSQL

Usage: fantoir-datasource <COMMAND>

Commands:
fetch Fetch the last version of the FANTOIR file
import Import from FANTOIR file generated by the DGFIP
promote Promote an imported FANTOIR table as the current FANTOIR table to use
wikidata Query Wikidata SPARQL end-point to enrich FANTOIR information
query Query the imported FANTOIR table
help Print this message or the help of the given subcommand(s)
</source>

=== Fetch ===

Check through the data.economie.gouv.fr API the last version available, compare with FANTOIRmmyy file present in working directory (if any). Download it, unzip it if needed.

To force overwrite the file, use <code>fantoir-datasource fetch --overwrite</code>.

Exit code can be used to programmatically know what happened:

{| class="wikitable"
|+ Exit codes
|-
! Code !! Description
|-
| 0 || Fetch operation succeeded
|-
| 2 || Parsing arguments issue (not fetch specific)
|-
| 4 || FANTOIR file already exist and --overwrite not specified
|-
| 8 || Download issue, at filesystem or HTTP level, stderr will provide information for humans or store in a log
|-
| n || Exit code from unzip command ([https://linux.die.net/man/1/unzip man 1 unzip])
|-
| 127 || Error with the unzip process, without knowing the unzip exit code
|}

If the file is extracted and all is fine, the script will print on stdout:

<source>
FANTOIR_FILE=FANTOIR1022
</source>