Mandato wsmapping

La herramienta wsmapping se utiliza para proporcionar correlación ascendente del modelo de objeto de entidad con el modelo relacional de base de datos. Puede utilizar la herramienta wsmapping para crear tablas de base de datos.

Sintaxis

Antes de ejecutar el mandato, debe tener una copia del archivo persistence.xml en la classpath o especificarlo como archivo de propiedades en el argumento -p [path_to_persistence.xml]. Emita el mandato desde el subdirectorio bin del directorio raíz_perfil.

La sintaxis del mandato es la siguiente:

[AIX][HP-UX][Linux][Solaris][z/OS]
wsmapping.sh [opciones][argumentos]
[IBM i]
wsmapping [opciones][argumentos] 
[Windows]
wsmapping.bat [opciones][argumentos]

Parámetros

La herramienta de correlación acepta el conjunto estándar de argumentos de la línea de mandatos definidos por la infraestructura de configuración con las opciones siguientes:
  • -schemaAction/-sa <add | refresh | drop | build | reflect | retain | createDB | import | export | none>: acción que se implementará en el esquema.

    Estas opciones corresponden a las acciones de la herramienta de esquema. Add es la acción predeterminada si no se especifica ninguna. Se pueden componer, separadas por comas, múltiples acciones en una lista.

    Nota: La herramienta wsmapping acepta el distintivo -action/-a para especificar la acción que se realizará en clases individuales. A menos que ejecute wsmapping en todos los tipos persistentes al mismo tiempo, o a menos que descarte una correlación, necesita utilizar la acción add predeterminada o la acción build. De lo contrario, es posible que descarte por accidente componentes del esquema que están siendo utilizados por clases en las que actualmente no está ejecutando la herramienta.
  • -schemaFile/-sf <true/t | false/f>: esta opción se puede utilizar para grabar el esquema planeado en un documento XML en lugar de modificar la base de datos.

    A continuación, el documento XML se puede modificar, manipular y confirmar en la base de datos con la herramienta de esquema.

  • -sqlFile/-sql <stdout | archivo salida>: esta opción se puede utilizar para grabar las modificaciones del esquema planeado en un script SQL en lugar de modificar la base de datos.

    Combine este parámetro con schemaAction de build a fin de generar un script que vuelva a crear el esquema para las correlaciones actuales, incluso si el esquema existe.

  • -dropTables/-dt <true/t | false/f>: si esta opción se establece en true, el esquema descarta las tablas que parecen no utilizadas durante las acciones retain y refresh.

    El valor predeterminado es true.

  • -dropSequences/-dsq < true/t | false/>: si esta opción se establece en true, el esquema descarta las secuencias que no se utilizan durante las acciones retain y refresh.

    El valor predeterminado es true.

  • -openjpatables/-ot <true/t | false/f>: cuando se refleja el esquema, este parámetro determina si se debe reflejar en las tablas y secuencias cuyos nombres empiezan por OPENJPA_.

    Algunos componentes de OpenJPA utilizan estas tablas y secuencias, como por ejemplo la fábrica de esquemas de tabla. Cuando se utilizan otras acciones, el parámetro openjpaTables controla si estas tablas se pueden descartar o no. El valor predeterminado es false.

  • -ignoreErrors/-i < true/t | false/>: Si se establece en false, se produce una excepción si la herramienta detecta errores de base de datos.

    El valor predeterminado es false.

  • -schemas/-s <lista de esquema>: indica una lista de nombres de esquemas y tablas a los que debe acceder OpenJPA al ejecutar la herramienta wsschema.

    Es equivalente al establecimiento de la propiedad openjpa.jdbc.Schemas para que se ejecute una vez. Este parámetro corresponde al parámetro -schemas/-s de la herramienta wsschema. Esta opción se ignora si -readSchema/-rs no se establece en true.

  • -readSchema/-rs < true/t | false/>: establezca esta opción en true para leer todo el esquema existente cuando se ejecute la herramienta de correlación.

    La lectura del esquema existente garantiza que OpenJPA no genere correlaciones que utilicen nombres de tabla, índice, clave primaria o clave foránea que estén en conflicto con nombres existentes.

    Nota: Dependiendo del controlador JDBC determinado, la selección de la función -readSchema/-rs puede ralentizar el proceso para esquemas grandes.
  • -primaryKeys/-pk <true/t | false/f>: este distintivo determina si se pueden manipular las claves primarias manualmente en las tablas existentes.

    El valor predeterminado es true.

  • -foreignKeys/fk <true/t | false/f>: este distintivo determina si se pueden manipular las claves foráneas en las tablas existentes.

    El valor predeterminado es true. Esto significa que para añadir una nueva clave foránea a una clase que ya se ha correlacionado, debe establecer explícitamente este distintivo del parámetro en true.

  • -indexes/-ix <true/t | false/f>: este distintivo determina si se pueden manipular los índices en las tablas existentes.

    El valor predeterminado es true. Esto significa que para añadir nuevos índices a una clase que ya se ha correlacionado, debe establecer explícitamente este distintivo del parámetro en true.

  • -sequences/-sq <true/t | false/f>: este distintivo determina si se pueden manipular las secuencias.

    El valor predeterminado es true.

  • -meta/-m <true/t | false/f>: este distintivo determina si una correlación se aplica a los metadatos en lugar de, o además de, las correlaciones estándar.
  • La herramienta wsmapping acepta el distintivo -action/-a para especificar la acción que se realizará en cada clase. Se pueden colocar múltiples acciones en una lista, separadas por comas. Las acciones disponibles son las siguientes:
    • buildSchema: es la acción predeterminada. La acción buildSchema hace que el esquema de base de datos coincida con las correlaciones existentes. Si las correlaciones proporcionadas entran en conflicto con las definiciones de clase, OpenJPA falla con una excepción informativa.
    • validate: asegúrese de que las correlaciones para las clases proporcionadas sean válidas y de que coincidan con el esquema de la base de datos. No se cambia ninguna correlación de tablas como resultado de esta acción. Se produce una excepción si alguna correlación no es válida.
Los argumentos adicionales de la herramienta wsmapping deben ser uno de los siguientes:
  • El nombre completo de una clase persistente.
  • El nombre .java de una clase persistente.
  • El archivo .class de una clase persistente.

Si no proporciona argumentos en la herramienta wsmapping, se ejecutará en las clases de la lista de clases persistentes.

Uso

Antes de ejecutar la herramienta wsmapping, debe configurar la información de origen de datos, incluido el URL, usuario y contraseña. Es necesario que se ejecute la herramienta wsenhancer antes de la herramienta wsmapping para insertar código de bytes en las clases de entidad. Además, los archivos de clase compilados de las entidades deben estar en la classpath. Supongamos que los archivos de clase de entidad se pueden encontrar en target/classes, por ejemplo:

[AIX][HP-UX][Linux][AIX HP-UX Solaris][Solaris][z/OS]
export CLASSPATH=${CLASSPATH}:target/classes 

wsmapping.sh ...
[IBM i]
export CLASSPATH=${CLASSPATH}:target/classes 

wsmapping ...
[Windows]
SET CLASSPATH=%CLASSPATH%;target\classes  

wsmapping.bat . . .

Para crear tablas, ejecute el mandato wsmapping desde el directorio ${raíz_perfil}/bin. Cuando se complete, se habrán creado o actualizado las tablas de base de datos. Se registrarán mensajes y errores en la consola administrativa según se haya especificado en los valores del registro.

wsmapping.sh . . . En Windows:

Consejo: Mediante la especificación del parámetro buildSchema en la propiedad openjpa.jdbc.SynchronizeMappings, la herramienta de correlación proporciona la correlación predeterminada que coincide con el esquema de base de datos automáticamente. No es necesario que ejecute esta herramienta de correlación si la correlación predeterminada satisface el esquema de base de datos necesario.

Ejemplos

Para crear las tablas de base de datos necesarias para el archivo Magazine.java:

[AIX][HP-UX][Linux][Solaris][z/OS]
${raíz_perfil}/bin/wsmapping.sh Magazine.java
[IBM i]
${raíz_pefil}/bin/wsmapping Magazine.java
[Windows]
${raíz_pefil}\bin\wsmapping.sh Magazine.java

Para descartar las tablas para Magazine.java:

[AIX][HP-UX][Linux][Solaris][z/OS]
C:\> %raíz_perfil%/bin/wsmapping.sh -sa dropDB Magazine.java
[IBM i]
C:\> %raíz_perfil%/bin/wsmapping -sa dropDB Magazine.java
[Windows]
C:\> %raíz_perfil%\bin\wsmapping.bat -sa dropDB Magazine.java

Para validar las correlaciones para todas las clases en la classpath:

[AIX][HP-UX][Linux][Solaris][z/OS]
C:\> %raíz_perfil%/bin/wsmapping.sh -a validate
[IBM i]
C:\> %raíz_perfil%/bin/wsmapping -a validate
[Windows]
C:\> %raíz_perfil\bin\wsmapping.bat -a validate

Información adicional

Consulte la información de correlación en la Guía de usuario de Apache OpenJPA para obtener más información y ejemplos.


Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rejb_wsmapping
File name: rejb_wsmapping.html