JDBC2XML Usage

= {{id name="JDBC2XMLUsage-JDBC2XMLUsage"/}}JDBC2XML Usage =

This section refers to the command-line tool. For information on the uses of the java library, please refer to our [[java documentation>>doc:JDBC2XML.Java Library Documentation.WebHome]].

4

5

= {{id name="JDBC2XMLUsage-Commands"/}}Commands =

6

7

JDBC2XML provides several commands, triggering different operations.

8

9

The following command overview only shows the absolut minimal number of options.

10

11

Usually more options are needed, especially {{code language="none"}}--user{{/code}}, {{code language="none"}}--password{{/code}}, and (Linux only, see bottom) {{code language="none"}}--jdbc-drivers{{/code}}.

12

13

See far below for a full list of options, as well as examples for JDBC URLs.

14

15

==== {{id name="JDBC2XMLUsage-DumpingaDBtoXML"/}}Dumping a DB to XML ====

16

17

18

jdbc2xml --url <jdbc-url> --file <path-to-file>

19

20

21

See below for details and example for JDBC URLs.

22

23

==== {{id name="JDBC2XMLUsage-RestoringaDBfromXML"/}}Restoring a DB from XML ====

24

25

26

xml2jdbc --file <path-to-file> --url <jdbc-url>

27

28

29

==== {{id name="JDBC2XMLUsage-CopyingfromoneDBtoanother"/}}Copying from one DB to another ====

30

31

32

jdbc2jdbc --from-url <jdbc-url> --to-url <jdbc-url>

33

34

35

==== {{id name="JDBC2XMLUsage-ParseandcopyanXMLfile"/}}Parse and copy an XML file ====

36

37

This can be useful for extracting a schema from a database (see options below)

38

39

40

xml2xml --from-file <path-to-file> --to-file <path-to-file>

41

42

43

==== {{id name="JDBC2XMLUsage-TestDBconnectionandserverstatus"/}}Test DB connection and server status ====

44

45

46

jdbcping --url <jdbc-url>

47

48

49

==== {{id name="JDBC2XMLUsage-ExtractpartsofaDB"/}}Extract parts of a DB ====

50

51

52

jdbcextr --url <jdbc-url> --file <path-to-file>

53

54

55

== {{id name="JDBC2XMLUsage-JDBCURLs"/}}JDBC URLs ==

56

57

JDBC URLs basically look like {{code language="none"}}jdbc:servertype://host[:port]/db?options{{/code}}., but some Databases and/or JDBC Drivers like other variants.

58

59

Typical examples are:

# MySQL

jdbc:mysql://localhost:3306/MYDATABASE?useCursorFetch=true

64

65

# MSSQL

66

jdbc:sqlserver://localhost:1433;databaseName=MYDATABASE;

67

68

69

The use of cursor fetching in mysql is highly recommended in order to circumvent java heap space exceptions while dumping the content of large tables.

70

71

== {{id name="JDBC2XMLUsage-Fulllistofoptions"/}}Full list of options ==

72

73

==== {{id name="JDBC2XMLUsage-Databaseaccess"/}}Database access ====

74

75

JDBC URL to access the DB.

--from-url "jdbcurl"

--to-url "jdbcurl"

--url "jdbcurl"

User to access the DB (some drivers can parse that from the URL):

--from-user user

--to-user user

--user user

Password to access the DB (some drivers can parse that from the URL):

93

94

95

--from-password password

96

--to-password password

--password password

==== {{id name="JDBC2XMLUsage-Fileaccess"/}}File access ====

101

102

Win32 wrapper needs absolut paths. The given filenames may contain compressed input. The implementation instantiates an appropriate inflating/deflating stream if the filename ends with .gz or .bz2

--from-file file

--to-file file

--file file

==== {{id name="JDBC2XMLUsage-Restrictprocessingtotables"/}}Restrict processing to tables ====

111

112

Whitelist tables (comma seperated, without whitespace)

113

114

115

--tables table1,table2,...

Blacklist tables

--exclude-tables table1,table2,...

122

123

124

Do not include table data in dump (creates a full schema from a populated database):

--no-data

Ignore constraints

--no-constraints

Combined{{code language="none"}}--no-data{{/code}} and {{code language="none"}}--no-constraints{{/code}}

--schema-only

==== {{id name="JDBC2XMLUsage-Expertoptions"/}}Expert options ====

143

144

Drop the affected tables before actually importing a dump. If {{code language="none"}}--tables{{/code}} or {{code language="none"}}--exclude-tables{{/code}} is given, only tables affected by the specified filter are dropped.

--drop-tables

Overrides the default bzip2 output compression, if {{code language="none"}}--to-file{{/code}} ends with .bz2

--compression <n>

Force a timezone

--timezone timezoneid

160

161

162

allows to select a JDBC driver, overriding autoselection

163

164

165

--from-driver drivername

166

--to-driver drivername

--driver drivername

Linux only: add given drivers to the classpath

171

172

173

--jdbc-drivers jarfilename[;jarfilename...]

174

175

176

==== {{id name="JDBC2XMLUsage-Optionsforjdbcbehaviour"/}}Options for jdbc behaviour ====

177

178

Change the batch size for inserts (def.: 1000)

--batch-size n

Fetch the contents of the database using a read-only transaction

--transactional

==== {{id name="JDBC2XMLUsage-Optionsforxmlreading"/}}Options for xml reading ====

191

192

Enable schema checking on the xml file

--check-xml-schema

Create an extra index on each foreign key

--create-fk-indices

==== {{id name="JDBC2XMLUsage-Optionsforxmlcreation"/}}Options for xml creation ====

205

206

Force or supress pretty printing of xml data

207

208

209

--pretty, --no-pretty

210

211

212

Forces the transformation of SQL identifiers to lower case

--to-lower

Force the transformation of SQL identifiers to upper case

--to-upper

Write internal indices, which are generated by the RDBMS

225

226

227

--keep-internal-indices

228

229

230

==== {{id name="JDBC2XMLUsage-OutputVerbosity"/}}Output Verbosity ====

231

232

The default log level prints {{code language="none"}}Fatal{{/code}}, {{code language="none"}}Error{{/code}} and {{code language="none"}}Warning{{/code}} logs

233

234

Suppresses any output except for the return code

--quiet

Increase log-level to {{code language="none"}}Info{{/code}}

241