hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 01:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

README and NOTICE updates/enhancements. Changing them all to be markdown format for easier viewing on GitHub

Browse Source
This commit is contained in:
Tim Donohue
2014-10-15 09:25:26 -05:00
parent f64c93943d
commit 71279b4d63
6 changed files with 131 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
dspace/etc/migrations/h2/H2_README.txt
View File

@@ -1,11 +0,0 @@
DSpace does NOT support the use of the H2 Database (http://www.h2database.com/)
in Production. Instead, DSpace uses the H2 Database to perform Unit Testing
during development.
By default, the DSpace Unit Testing environment configures H2 to run in
"Oracle Mode" and initializes the H2 database using the scripts in this directory.
The H2 migrations in this directory are *based on* the Oracle Migrations
(/migrations/oracle/*.sql), but with some modifications in order to be valid
in H2. For reference see the H2 SQL Grammar:
http://www.h2database.com/html/grammar.html

37
dspace/etc/migrations/h2/README.md Normal file
View File

@@ -0,0 +1,37 @@
# H2 Flyway Database Migrations (i.e. Upgrades)
**WARNING:** DSpace does NOT support the use of the [H2 Database](http://www.h2database.com/)
in Production. Instead, DSpace uses the H2 Database to perform Unit Testing
during development.
By default, the DSpace Unit Testing environment configures H2 to run in
"Oracle Mode" and initializes the H2 database using the scripts in this directory.
These database migrations are automatically called by [Flyway](http://flywaydb.org/)
when the `DatabaseManager` initializes itself (see `initializeDatabase()` method).
The H2 migrations in this directory are *based on* the Oracle Migrations
(`[src]/dspace/etc/migrations/oracle/*.sql`), but with some modifications in
order to be valid in H2. For reference see the [H2 SQL Grammar](http://www.h2database.com/html/grammar.html).
## More Information
The SQL scripts in this directory are H2-specific database migrations. They are
used to automatically upgrade your DSpace database using [Flyway](http://flywaydb.org/).
As such, these scripts are automatically called by Flyway when the DSpace
`DatabaseManager` initializes itself (see `initializeDatabase()` method). During
that process, Flyway determines which version of DSpace your database is using
and then executes the appropriate upgrade script(s) to bring it up to the latest
version.
If any failures occur, Flyway will "rollback" the upgrade script which resulted
in an error and log the issue in the DSpace log file at `[dspace]/log/dspace.log.[date]`
**WARNING:** IT IS NOT RECOMMENDED TO RUN THESE SCRIPTS MANUALLY. If you do so,
Flyway will may throw failures the next time you startup DSpace, as Flyway will
not realize you manually ran one or more scripts.
Please see the Flyway Documentation for more information: http://flywaydb.org/

30
dspace/etc/migrations/oracle/ORACLE_README.txt → dspace/etc/migrations/oracle/README.md
View File

@@ -1,10 +1,23 @@
DSpace on Oracle
Revision: 11-sep-04 dstuve
# Oracle Flyway Database Migrations (i.e. Upgrades)
(Installation notes moved to main DSpace documentation)
The SQL scripts in this directory are Oracle-specific database migrations. They are
used to automatically upgrade your DSpace database using [Flyway](http://flywaydb.org/).
As such, these scripts are automatically called by Flyway when the DSpace
`DatabaseManager` initializes itself (see `initializeDatabase()` method). During
that process, Flyway determines which version of DSpace your database is using
and then executes the appropriate upgrade script(s) to bring it up to the latest
version.
If any failures occur, Flyway will "rollback" the upgrade script which resulted
in an error and log the issue in the DSpace log file at `[dspace]/log/dspace.log.[date]`
Oracle Porting Notes for the Curious
**WARNING:** IT IS NOT RECOMMENDED TO RUN THESE SCRIPTS MANUALLY. If you do so,
Flyway will may throw failures the next time you startup DSpace, as Flyway will
not realize you manually ran one or more scripts.
Please see the Flyway Documentation for more information: http://flywaydb.org/
## Oracle Porting Notes for the Curious
Oracle is missing quite a number of cool features found in Postgres, so
workarounds had to be found, most of which are hidden behind tests in
@@ -42,7 +55,8 @@ for now. Note that with UTF-8 encoding that 4k could translate to 1300
characters worst-case (every character taking up 3 bytes is the worst case
scenario.)
==UPDATE 5 April 2007==
### UPDATE 5 April 2007
CLOBs are now used as follows:
MetadataValue:text_value
Community:introductory_text
@@ -50,7 +64,6 @@ Community:copyright_text
Collection:introductory_text
Collection:license
Collection:copyright_text
== ==
DatabaseManager had to have some of the type checking changed, because Oracle's
JDBC driver is reporting INTEGERS as type DECIMAL.
@@ -59,7 +72,8 @@ Oracle doesn't like it when you reference table names in lower case when
getting JDBC metadata for the tables, so they are converted in TableRow
to upper case.
==UPDATE 27 November 2012==
### UPDATE 27 November 2012
Oracle complains with ORA-01408 if you attempt to create an index on a column which
has already had the UNIQUE contraint added (such an index is implicit in maintaining the uniqueness
of the column). See DS-1370 for details.
of the column). See [DS-1370](https://jira.duraspace.org/browse/DS-1370) for details.

20
dspace/etc/migrations/postgres/README.md Normal file
View File

@@ -0,0 +1,20 @@
# PostgreSQL Flyway Database Migrations (i.e. Upgrades)
The SQL scripts in this directory are PostgreSQL-specific database migrations. They are
used to automatically upgrade your DSpace database using [Flyway](http://flywaydb.org/).
As such, these scripts are automatically called by Flyway when the DSpace
`DatabaseManager` initializes itself (see `initializeDatabase()` method). During
that process, Flyway determines which version of DSpace your database is using
and then executes the appropriate upgrade script(s) to bring it up to the latest
version.
If any failures occur, Flyway will "rollback" the upgrade script which resulted
in an error and log the issue in the DSpace log file at `[dspace]/log/dspace.log.[date]`
**WARNING:** IT IS NOT RECOMMENDED TO RUN THESE SCRIPTS MANUALLY. If you do so,
Flyway will may throw failures the next time you startup DSpace, as Flyway will
not realize you manually ran one or more scripts.
Please see the Flyway Documentation for more information: http://flywaydb.org/

40
dspace/etc/oracle/NOTICE.md
View File

@@ -1,22 +1,34 @@
DSpace Database Now Upgrades Automatically
##############################################
# DSpace Database Now Upgrades Automatically
AS OF DSPACE 5.0, the DSpace database now upgrades AUTOMATICALLY.
AS OF DSPACE 5.0, the DSpace database now upgrades itself AUTOMATICALLY.
Therefore, all "database_schema*.sql" files have been removed. Starting
with DSpace 4.0 -> 5.0 upgrade, you will no longer need to manually run any
SQL scripts.
Therefore, all `database_schema*.sql` files have been removed. Starting
with DSpace 4.x -> 5.0 upgrade, you will no longer need to manually run any
SQL scripts to upgrade your database.
However, if you have not yet upgraded to DSpace 4.0, YOU MUST MANUALLY DO SO.
Those manual "database_schema*.sql" scripts can still be found in the
DSpace 4.0 source code at:
However, if you have not yet upgraded to DSpace 4.x, YOU MUST MANUALLY DO SO.
Those manual `database_schema*.sql` scripts can still be found in the
DSpace 4.x source code at:
https://github.com/DSpace/DSpace/tree/dspace-4_x/dspace/etc/oracle/
## More info on automatic database upgrades (for developers)
MORE INFO (for Developers):
---------------------------
As of DSpace 5.0, we now use [Flyway DB](http://flywaydb.org/) along with
the scripts under `[dspace]/etc/migrations/oracle` to automatically keep your
DSpace database up-to-date.
As of DSpace 5.0, we now use Flyway DB (http://flywaydb.org/) along with
the scripts under [dspace]/etc/migrations/ to automatically keep your DSpace
database up-to-date.
As Flyway automates the upgrade process, you should NEVER run these scripts
manually. For more information, please see the `README` in the scripts directory.
## Using the update-sequences.sql script
The `update-sequences.sql` script in this directory may still be used to update
your internal database counts if you feel they have gotten out of "sync". This
may sometimes occur after large restores of content (e.g. when using the DSpace
[AIP Backup and Restore](https://wiki.duraspace.org/display/DSDOC5x/AIP+Backup+and+Restore)
feature).
This `update-sequences.sql` script can be run manually. It will not harm your
database (or its contents) in any way. It just ensures all database counts (i.e.
sequences) are properly set to the next available value.

40
dspace/etc/postgres/NOTICE.md
View File

@@ -1,22 +1,34 @@
DSpace Database Now Upgrades Automatically
##############################################
# DSpace Database Now Upgrades Automatically
AS OF DSPACE 5.0, the DSpace database now upgrades AUTOMATICALLY.
AS OF DSPACE 5.0, the DSpace database now upgrades itself AUTOMATICALLY.
Therefore, all "database_schema*.sql" files have been removed. Starting
with DSpace 4.0 -> 5.0 upgrade, you will no longer need to manually run any
SQL scripts.
Therefore, all `database_schema*.sql` files have been removed. Starting
with DSpace 4.x -> 5.0 upgrade, you will no longer need to manually run any
SQL scripts to upgrade your database.
However, if you have not yet upgraded to DSpace 4.0, YOU MUST MANUALLY DO SO.
Those manual "database_schema*.sql" scripts can still be found in the
DSpace 4.0 source code at:
However, if you have not yet upgraded to DSpace 4.x, YOU MUST MANUALLY DO SO.
Those manual `database_schema*.sql` scripts can still be found in the
DSpace 4.x source code at:
https://github.com/DSpace/DSpace/tree/dspace-4_x/dspace/etc/postgres/
## More info on automatic database upgrades
MORE INFO (for Developers):
---------------------------
As of DSpace 5.0, we now use [Flyway DB](http://flywaydb.org/) along with
the scripts under `[dspace]/etc/migrations/oracle` to automatically keep your
DSpace database up-to-date.
As of DSpace 5.0, we now use Flyway DB (http://flywaydb.org/) along with
the scripts under [dspace]/etc/migrations/ to automatically keep your DSpace
database up-to-date.
As Flyway automates the upgrade process, you should NEVER run these scripts
manually. For more information, please see the `README` in the scripts directory.
## Using the update-sequences.sql script
The `update-sequences.sql` script in this directory may still be used to update
your internal database counts if you feel they have gotten out of "sync". This
may sometimes occur after large restores of content (e.g. when using the DSpace
[AIP Backup and Restore](https://wiki.duraspace.org/display/DSDOC5x/AIP+Backup+and+Restore)
feature).
This `update-sequences.sql` script can be run manually. It will not harm your
database (or its contents) in any way. It just ensures all database counts (i.e.
sequences) are properly set to the next available value.