Skip to content

SIARD Metadata Edition

Jump to bottom Edit New page
Miguel Guimarães edited this page Apr 6, 2022 · 3 revisions

SIARD Metadata Edition

Use case

Every description field in metadata file can be altered to add more context to the SIARD itself. Allowing users to have a better understand of what the meaning of some table was. For instance, a database have a set of tables and one of those tables have three columns named c1, c2 and c3, from those values it is impossible to infer what kind of data those columns may hold. After the migration process you can edit the SIARD metadata and add description for those three columns improving the database context.

How to use

To show the list of fields that are available for editing:

dbptk edit --import-file <path-to-siard>

To set some description:

dbptk edit --import-file <path-to-siard> [--set key value]

Example

dbptk edit --import-file sakila.siard
   Listing SIARD metadata of sakila.siard
   Importing SIARD version 2.1
     --set dbname              'sakila'
     --set description         'unspecified'
     --set archiver            'unspecified'
     --set archiverContact     'unspecified'
     --set dataOwner           'unspecified'
     --set dataOriginTimespan  'unspecified'
     --set producerApplication 'Database Preservation Toolkit (version 2.9.6)'
     --set archivalDate        '2020-10-07+00:00'
     --set clientMachine       'mguimaraes (fetched automatically)'
     --set databaseProduct     'MySQL 5.6.49'
     --set connection          ''
     --set databaseUser        ''
     (...)

dbptk edit --import-file sakila.siard --set dbname 'new_database_name'

Copyright © 2019 by KEEP SOLUTIONS

All rights reserved. No part of this publication may be reproduced, distributed, or transmitted in any form or by any means, including photocopying, recording, or other electronic or mechanical methods, without the prior written permission of the publisher, except in the case of brief quotations embodied in critical reviews and certain other noncommercial uses permitted by copyright law. For permission requests, write to the publisher, addressed “Attention: Permissions Coordinator,” at the address below.

KEEP SOLUTIONS, LDA.
Rua Rosalvo de Almeida, nº 5
4710-429 Braga, Portugal
W www.keep.pt E info@keep.pt
Add a custom sidebar
Clone this wiki locally