30-schema.sql
No OneTemporary
Actions

Size

5 KB

Subscribers

None

30-schema.sql
View Options

	---
	--- Software Heritage Indexers Data Model
	---

	-- Computing metadata on sha1's contents

	-- a SHA1 checksum (not necessarily originating from Git)
	create domain sha1 as bytea check (length(value) = 20);

	-- a Git object ID, i.e., a SHA1 checksum
	create domain sha1_git as bytea check (length(value) = 20);

	create table indexer_configuration (
	id serial not null,
	tool_name text not null,
	tool_version text not null,
	tool_configuration jsonb
	);

	comment on table indexer_configuration is 'Indexer''s configuration version';
	comment on column indexer_configuration.id is 'Tool identifier';
	comment on column indexer_configuration.tool_version is 'Tool name';
	comment on column indexer_configuration.tool_version is 'Tool version';
	comment on column indexer_configuration.tool_configuration is 'Tool configuration: command line, flags, etc...';

	-- Properties (mimetype, encoding, etc...)
	create table content_mimetype (
	id sha1 not null,
	mimetype text not null,
	encoding text not null,
	indexer_configuration_id bigint not null
	);

	comment on table content_mimetype is 'Metadata associated to a raw content';
	comment on column content_mimetype.mimetype is 'Raw content Mimetype';
	comment on column content_mimetype.encoding is 'Raw content encoding';
	comment on column content_mimetype.indexer_configuration_id is 'Tool used to compute the information';

	create table fossology_license(
	id smallserial,
	name text not null
	);

	comment on table fossology_license is 'Possible license recognized by license indexer';
	comment on column fossology_license.id is 'License identifier';
	comment on column fossology_license.name is 'License name';

	create table content_fossology_license (
	id sha1 not null,
	license_id smallserial not null,
	indexer_configuration_id bigint not null
	);

	comment on table content_fossology_license is 'license associated to a raw content';
	comment on column content_fossology_license.id is 'Raw content identifier';
	comment on column content_fossology_license.license_id is 'One of the content''s license identifier';
	comment on column content_fossology_license.indexer_configuration_id is 'Tool used to compute the information';


	-- The table content_metadata provides a translation to files
	-- identified as potentially containning metadata with a translation tool (indexer_configuration_id)
	create table content_metadata(
	id sha1 not null,
	metadata jsonb not null,
	indexer_configuration_id bigint not null
	);

	comment on table content_metadata is 'metadata semantically translated from a content file';
	comment on column content_metadata.id is 'sha1 of content file';
	comment on column content_metadata.metadata is 'result of translation with defined format';
	comment on column content_metadata.indexer_configuration_id is 'tool used for translation';

	-- The table directory_intrinsic_metadata provides a minimal set of intrinsic
	-- metadata detected with the detection tool (indexer_configuration_id) and
	-- aggregated from the content_metadata translation.
	create table directory_intrinsic_metadata(
	id sha1_git not null,
	metadata jsonb not null,
	indexer_configuration_id bigint not null,
	mappings text array not null
	);

	comment on table directory_intrinsic_metadata is 'metadata semantically detected and translated in a directory';
	comment on column directory_intrinsic_metadata.id is 'sha1_git of directory';
	comment on column directory_intrinsic_metadata.metadata is 'result of detection and translation with defined format';
	comment on column directory_intrinsic_metadata.indexer_configuration_id is 'tool used for detection';
	comment on column directory_intrinsic_metadata.mappings is 'type of metadata files used to obtain this metadata (eg. pkg-info, npm)';

	create table origin_intrinsic_metadata(
	id text not null, -- origin url
	metadata jsonb,
	indexer_configuration_id bigint not null,
	from_directory sha1_git not null,
	metadata_tsvector tsvector,
	mappings text array not null
	);

	comment on table origin_intrinsic_metadata is 'keeps intrinsic metadata for an origin';
	comment on column origin_intrinsic_metadata.id is 'url of the origin';
	comment on column origin_intrinsic_metadata.metadata is 'metadata extracted from a directory';
	comment on column origin_intrinsic_metadata.indexer_configuration_id is 'tool used to generate this metadata';
	comment on column origin_intrinsic_metadata.from_directory is 'sha1 of the directory this metadata was copied from.';
	comment on column origin_intrinsic_metadata.mappings is 'type of metadata files used to obtain this metadata (eg. pkg-info, npm)';

	create table origin_extrinsic_metadata(
	id text not null, -- origin url
	metadata jsonb,
	indexer_configuration_id bigint not null,
	from_remd_id sha1_git not null,
	metadata_tsvector tsvector,
	mappings text array not null
	);

	comment on table origin_extrinsic_metadata is 'keeps extrinsic metadata for an origin';
	comment on column origin_extrinsic_metadata.id is 'url of the origin';
	comment on column origin_extrinsic_metadata.metadata is 'metadata extracted from a directory';
	comment on column origin_extrinsic_metadata.indexer_configuration_id is 'tool used to generate this metadata';
	comment on column origin_extrinsic_metadata.from_remd_id is 'sha1 of the directory this metadata was copied from.';
	comment on column origin_extrinsic_metadata.mappings is 'type of metadata files used to obtain this metadata (eg. github, gitlab)';

File Metadata

Mime Type: text/plain
Expires: Jun 4 2025, 7:54 PM (14 w, 1 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 3238071

30-schema.sqlNo OneTemporaryActions

30-schema.sqlView Options

File Metadata

Event Timeline

30-schema.sql
No OneTemporary
Actions

30-schema.sql
View Options