Adding a Field to a Live Repository - Revision history

Ajm: Line return adjustments.

2023-07-17T17:24:06Z

Line return adjustments.

← Older revision		Revision as of 17:24, 17 July 2023
Line 47:		Line 47:

	Then, once you have added your new field definitions to the appropriate configuration file you can run ''update'' via [[API:bin/epadmin\|epadmin]] from the shell.		Then, once you have added your new field definitions to the appropriate configuration file you can run ''update'' via [[API:bin/epadmin\|epadmin]] from the shell.


	You can begin with a dry run to see what would happen:		You can begin with a dry run to see what would happen:
Line 55:		Line 56:

	./bin/epadmin update ARCHIVEID		./bin/epadmin update ARCHIVEID

Ajm at 17:21, 17 July 2023

2023-07-17T17:21:18Z

← Older revision		Revision as of 17:21, 17 July 2023
Line 46:		Line 46:


	Then, once you have added your new field definitions to the appropriate configuration file you can run ''update'' via [[API:bin/epadmin\|epadmin]] from the shell:		Then, once you have added your new field definitions to the appropriate configuration file you can run ''update'' via [[API:bin/epadmin\|epadmin]] from the shell.

			You can begin with a dry run to see what would happen:

			./bin/epadmin update_dry_run ARCHIVEID

			Then once confident proceed for real:

	./bin/epadmin update ARCHIVEID		./bin/epadmin update ARCHIVEID


	=== EPrints 3.1+ ===		=== EPrints 3.1+ ===

Ajm: /* EPrints 3.3+ */ - changed 'maybe' option to 'partial' to match previous examples from the page HOW TO: Add a New Field

2023-07-17T17:18:58Z

EPrints 3.3+: - changed 'maybe' option to 'partial' to match previous examples from the page HOW TO: Add a New Field

← Older revision		Revision as of 17:18, 17 July 2023
Line 23:		Line 23:
	'yes',		'yes',
	'no',		'no',
	'~~maybe~~',		'partial',
	],		],
	input_rows => 1,		input_rows => 1,
Line 34:		Line 34:
	'yes',		'yes',
	'no',		'no',
	'~~maybe~~',		'partial',
	],		],
	input_rows => 1,		input_rows => 1,
Line 49:		Line 49:

	./bin/epadmin update ARCHIVEID		./bin/epadmin update ARCHIVEID


	=== EPrints 3.1+ ===		=== EPrints 3.1+ ===

Ajm: Brought the most recent documentation to the top, so the warnings about needing to modify the SQL tables was clearly referring to 3.0 and not 3.3+.

2023-07-17T17:08:19Z

Brought the most recent documentation to the top, so the warnings about needing to modify the SQL tables was clearly referring to 3.0 and not 3.3+.

@@ Line 3: / Line 3: @@
 [[Category: Out of Date]]
-To add a field to a live eprints archive you have to modify the SQL tables.
+=== EPrints 3.3+ ===
-Before you start this you may wish to BackupTheDatabase.
+Follow the instructions as you would for [[HOW TO: Add a New Field]].
-This assumes you are adding a field to the "eprint" fields, not the "user" fields. If you are changing "user" then anywhere we have 4 actions, one for each of buffer, deletion, archive and inbox, you instead need a single action for "users".
+As described there, you define your new fields in...
-== Recipe (for Eprints 3.x) ==
+Since a repository's <code>eprint_fields.pl</code> will override a flavour's <code>eprint_fields.pl</code> based on them both having the same file name, should you only wish to add to a flavour's fields rather than replace them, you may prefer to give your archive's local version a file name such as <code>eprint_fields_local.pl</code>, and then inside have only your new field(s):
-This is much the same as for Eprints 2.x except that the names have been changed to protect the innocent.
+ push @{$c->{fields}->{eprint}},
-=== EPrints 3.0 ===
+Simply make sure your <code>push</code>, is adding your field to the correct dataset you wish to add fields to - in this case an <code>eprint</code> dataset.
 === EPrints 3.1+ ===
-Once you have added your new field definitions to the appropriate configuration file you can run the update_database_structure [[API:bin/epadmin|epadmin]] method from the shell:
+EPrint 3.3's ''update'' is a synonym of the ''update_database_structure'' method available from Eprints 3.1+:
   ./bin/epadmin update_database_structure ARCHIVEID
-In EPrints 3.3+ you can use ''update'' as a synonym of ''update_database_structure''.

Kgoetz: appears out of date and needing an update

2018-09-12T00:47:06Z

appears out of date and needing an update

← Older revision		Revision as of 00:47, 12 September 2018
Line 1:		Line 1:
	[[Category:Manual]]		[[Category:Manual]]
	[[Category:Metadata Fields]]		[[Category:Metadata Fields]]
			[[Category: Out of Date]]

	To add a field to a live eprints archive you have to modify the SQL tables.		To add a field to a live eprints archive you have to modify the SQL tables.

Tdb01r: /* EPrints 3.1+ */

2011-12-09T15:51:54Z

EPrints 3.1+

← Older revision		Revision as of 15:51, 9 December 2011
Line 26:		Line 26:
	=== EPrints 3.1+ ===		=== EPrints 3.1+ ===

	Once you have added your new field definitions to the appropriate configuration file you can run the update_database_structure epadmin method from the shell:		Once you have added your new field definitions to the appropriate configuration file you can run the update_database_structure [[API:bin/epadmin\|epadmin]] method from the shell:

	./bin/epadmin update_database_structure ARCHIVEID		./bin/epadmin update_database_structure ARCHIVEID

			In EPrints 3.3+ you can use ''update'' as a synonym of ''update_database_structure''.

Pm705 at 12:47, 20 March 2010

2010-03-20T12:47:50Z

← Older revision		Revision as of 12:47, 20 March 2010
Line 1:		Line 1:
	[[Category:Manual]]		[[Category:Manual]]
	[[Category:~~Howto~~]]		[[Category:Metadata Fields]]

	To add a field to a live eprints archive you have to modify the SQL tables.		To add a field to a live eprints archive you have to modify the SQL tables.

Pm705 at 21:23, 13 March 2010

2010-03-13T21:23:09Z

← Older revision		Revision as of 21:23, 13 March 2010
Line 9:		Line 9:

	Adding fields of type "name" is beyond the scope of these instructions.		Adding fields of type "name" is beyond the scope of these instructions.

	~~== Recipe (for Eprints 2.x)==~~

	~~=== Step 1 - Shut down apache ===~~
	~~Shut down the web server. You don't want people using it while you make this change.~~

	~~=== Step 2 - Add configuration ===~~
	~~Add the configuration for this field to MetadataFieldsConfig.pm - take note of which field you add this new field after. (from now on I'll refer to the previous field as ''prevfield''.~~

	~~=== Step 3 - Add fields to database ===~~

	~~Find out the SQL type of the field you are adding.~~

	~~boolean~~
	~~:: '''SET('TRUE','FALSE')'''~~
	~~date~~
	~~:: '''DATE'''~~
	~~year, int~~
	~~:: '''INTEGER'''~~
	~~longtext~~
	~~:: '''TEXT'''~~
	~~subject,set,url,email,pagerange,text~~
	~~:: '''VARCHAR(255)'''~~

	~~Note that if the field is type multiple then this step is different.~~

	~~For both steps the following replacements must be applied to the MySQL code given:~~

	* Replace ''type'' with the SQL type appropriate to the field you are adding.
	* Replace ''newfieldname'' with the name of the field you're adding
	* Replace ''prevfield'' with the name of the (non-multiple) field proceeding the field you are adding. If prevfield is a multiple then use the first non-multiple field proceeding your new field. (not used for multiple fields)

	~~''Now only do step 3a or 3b depending if this field is multiple or not''~~

	~~==== Step 3a - Adding a normal field ====~~

	~~In the database (log into CommandLineMySQL) do the following:~~


	~~If this is confusing see the example at the end of the page.~~


	~~ALTER TABLE archive ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';~~
	~~ALTER TABLE buffer ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';~~
	~~ALTER TABLE inbox ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';~~
	~~ALTER TABLE deletion ADD ''newfieldname'' ''type'' default NULL AFTER ''prevfield'';~~

	~~==== Step 3b - Adding a "multiple" field ====~~

	~~Multiple fields need their own table, so the syntax is different.~~

	~~Please note that these commands have been split over multiple lines for readability.~~

	~~CREATE TABLE archive_''newfieldname'' ( eprintid INT NOT NULL, pos INT,~~
	~~''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) );~~

	~~CREATE TABLE buffer_''newfieldname'' ( eprintid INT NOT NULL, pos INT,~~
	~~''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) );~~

	~~CREATE TABLE inbox_''newfieldname'' ( eprintid INT NOT NULL, pos INT,~~
	~~''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) );~~

	~~CREATE TABLE deletion_''newfieldname'' ( eprintid INT NOT NULL, pos INT,~~
	~~''newfieldname'' ''type'' default NULL, KEY eprintid (eprintid), KEY pos (pos) );~~

	~~=== Step 4 - Modify the ordervalues tables ===~~

	~~The ordervalues table is used to store a "dumbed down" version of the value in your field used for sorting, but never rendered.~~

	~~The same replacement values apply as for step 3 with one difference. The ''prevfield'' is the previous field in ArchiveMetadataFieldsConfig.pm even if it is a multiple field.~~

	~~Notes:~~
	* there are two underline characters before "ordervalues".
	* this assumes you are not running a multilanguage or non-english archive. If you ''are'' then repeat the 4 commands below and replace 'en' with each of your archive's languages in turn.

	~~ALTER TABLE archive__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';~~
	~~ALTER TABLE buffer__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';~~
	~~ALTER TABLE inbox__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';~~
	~~ALTER TABLE deletion__ordervalues_en ADD ''fieldname'' TEXT AFTER ''prevfield'';~~

	~~=== Step 5 - Checking it works... ===~~

	~~It should all be OK at this point, but it's worth checking. I suggest running generate_views on the archive to make sure it all works OK.~~

	~~=== Step 6 - Finishing up ===~~

	~~Add the config to metadata-types.xml and phrases.xml - see AddingFields~~

	~~=== Step 7 - Restart apache ===~~

	~~Everything should now be OK. restart the webserver~~

	~~----~~

	~~== Examples (for Eprints 2.x) ==~~


	~~=== Normal set field example ===~~
	~~To add a field of type 'set' to eprints. We add this to ArchveMetadataFieldsConfig.pm~~

	~~{ name => "foo", type => "set", input_rows => 1,~~
	~~options => [ "yesod", "hod", "chesed" ] },~~

	~~The previous field is a (non-multiple) text field called 'bar')~~

	~~then run the following SQL statements:~~

	~~ALTER TABLE archive ADD foo VARCHAR(255) default NULL AFTER bar;~~
	~~ALTER TABLE buffer ADD foo VARCHAR(255) default NULL AFTER bar;~~
	~~ALTER TABLE inbox ADD foo VARCHAR(255) default NULL AFTER bar;~~
	~~ALTER TABLE deletion ADD foo VARCHAR(255) default NULL AFTER bar;~~

	~~ALTER TABLE archive__ordervalues_en ADD foo TEXT AFTER bar;~~
	~~ALTER TABLE buffer__ordervalues_en ADD foo TEXT AFTER bar;~~
	~~ALTER TABLE inbox__ordervalues_en ADD foo TEXT AFTER bar;~~
	~~ALTER TABLE deletion__ordervalues_en ADD foo TEXT AFTER bar;~~



	== Recipe (for Eprints 3.x) ==		== Recipe (for Eprints 3.x) ==

Pm705 at 13:21, 8 February 2010

2010-02-08T13:21:07Z

← Older revision		Revision as of 13:21, 8 February 2010
Line 1:		Line 1:
			[[Category:Manual]]
			[[Category:Howto]]

	To add a field to a live eprints archive you have to modify the SQL tables.		To add a field to a live eprints archive you have to modify the SQL tables.

Tdb01r: /* Recipe (for Eprints 3.x) */

2009-07-13T13:00:44Z

Recipe (for Eprints 3.x)

← Older revision		Revision as of 13:00, 13 July 2009
Line 130:		Line 130:

	* Define your new fields in <tt>archives/ARCHIVEID/cfg/cfg.d/eprint_fields.pl</tt> for EPrint-level metadata, <tt>.../document_fields.pl</tt> for document-level metadata (this file doesn't exist by default, but is honoured), <tt>.../user_fields.pl</tt> for user metadata, etc etc.		* Define your new fields in <tt>archives/ARCHIVEID/cfg/cfg.d/eprint_fields.pl</tt> for EPrint-level metadata, <tt>.../document_fields.pl</tt> for document-level metadata (this file doesn't exist by default, but is honoured), <tt>.../user_fields.pl</tt> for user metadata, etc etc.

			=== EPrints 3.0 ===

	* Add the new columns to the appropriate tables. There are no longer four separate tables for eprints as there were in EP2 (<tt>archive</tt>, <tt>buffer</tt> etc), so it's simpler.		* Add the new columns to the appropriate tables. There are no longer four separate tables for eprints as there were in EP2 (<tt>archive</tt>, <tt>buffer</tt> etc), so it's simpler.
	** For a field defined in <tt>eprint_fields.pl</tt>, the tables are <tt>eprint</tt> and <tt>eprint__ordervalues_en</tt> (replacing <tt>en</tt> with your language as required).		** For a field defined in <tt>eprint_fields.pl</tt>, the tables are <tt>eprint</tt> and <tt>eprint__ordervalues_en</tt> (replacing <tt>en</tt> with your language as required).
Line 135:		Line 138:
	** And so on.		** And so on.
	* The column types are the same as for EP2, ie in <tt>eprint</tt> you want a type appropriate to the type of your field exactly as described in the Recipe for EP2 above, while in <tt>eprint__ordervalues_en</tt> you want <tt>text</tt> irrespective of your field type.		* The column types are the same as for EP2, ie in <tt>eprint</tt> you want a type appropriate to the type of your field exactly as described in the Recipe for EP2 above, while in <tt>eprint__ordervalues_en</tt> you want <tt>text</tt> irrespective of your field type.

	~~=== EPrints 3.0 ===~~

	~~Follow the same database instructions above.~~

	=== EPrints 3.1+ ===		=== EPrints 3.1+ ===
Line 144:		Line 143:
	Once you have added your new field definitions to the appropriate configuration file you can run the update_database_structure epadmin method from the shell:		Once you have added your new field definitions to the appropriate configuration file you can run the update_database_structure epadmin method from the shell:

	./bin/epadmin update_database_structure ~~devel~~		./bin/epadmin update_database_structure ARCHIVEID