~drizzle-trunk/drizzle/development

client is a backup program originally written by Igor Romanenko. It can be used to dump a database or a collection of databases for backup or transfer to another SQL server (not necessarily a drizzle server). The dump typically contains SQL statements to create the table, populate it, or both. However,

\fBdrizzledump\fR

can also be used to generate files in CSV, other delimited text, or XML format.

.PP

There are three general ways to invoke

\fBdrizzledump\fR:

.sp

.RS 3n

.nf

shell> \fBdrizzledump [\fR\fB\fIoptions\fR\fR\fB] \fR\fB\fIdb_name\fR\fR\fB [\fR\fB\fItables\fR\fR\fB]\fR

shell> \fBdrizzledump [\fR\fB\fIoptions\fR\fR\fB] \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB \fR\fB\fIdb_name3\fR\fR\fB...]\fR

shell> \fBdrizzledump [\fR\fB\fIoptions\fR\fR\fB] \-\-all\-databases\fR

.fi

.RE

.PP

If you do not name any tables following

\fIdb_name\fR

or if you use the

\fB\-\-databases\fR

\fB\-\-all\-databases\fR

option, entire databases are dumped.

.PP

\fBdrizzledump\fR

does not dump the

INFORMATION_SCHEMA

database. If you name that database explicitly on the command line,

\fBdrizzledump\fR

silently ignores it.

.PP

To get a list of the options your version of

\fBdrizzledump\fR

supports, execute

\fBdrizzledump \-\-help\fR.

.PP

Some

\fBdrizzledump\fR

options are shorthand for groups of other options.

\fB\-\-opt\fR

and

\fB\-\-compact\fR

fall into this category. For example, use of

\fB\-\-opt\fR

is the same as specifying

\fB\-\-add\-drop\-table\fR

\fB\-\-add\-locks\fR

\fB\-\-create\-options\fR

\fB\-\-disable\-keys\fR

\fB\-\-extended\-insert\fR

\fB\-\-lock\-tables\fR

\fB\-\-quick\fR

\fB\-\-set\-charset\fR. Note that all of the options that

\fB\-\-opt\fR

stands for also are on by default because

\fB\-\-opt\fR

is on by default.

.PP

To reverse the effect of a group option, uses its

\fB\-\-skip\-\fR\fB\fIxxx\fR\fR

form (\fB\-\-skip\-opt\fR

\fB\-\-skip\-compact\fR). It is also possible to select only part of the effect of a group option by following it with options that enable or disable specific features. Here are some examples:

.TP 3n

\(bu

To select the effect of

\fB\-\-opt\fR

except for some features, use the

\fB\-\-skip\fR

option for each feature. For example, to disable extended inserts and memory buffering, use

\fB\-\-opt\fR

\fB\-\-skip\-extended\-insert\fR

\fB\-\-skip\-quick\fR. (

\fB\-\-skip\-extended\-insert\fR

\fB\-\-skip\-quick\fR

is sufficient because

\fB\-\-opt\fR

is on by default.)

.TP 3n

100

\(bu

101

To reverse

102

\fB\-\-opt\fR

103

for all features except index disabling and table locking, use

104

\fB\-\-skip\-opt\fR

105

\fB\-\-disable\-keys\fR

106

\fB\-\-lock\-tables\fR.

107

.sp

108

.RE

109

.PP

110

When you selectively enable or disable the effect of a group option, order is important because options are processed first to last. For example,

111

\fB\-\-disable\-keys\fR

112

\fB\-\-lock\-tables\fR

113

\fB\-\-skip\-opt\fR

114

would not have the intended effect; it is the same as

115

\fB\-\-skip\-opt\fR

116

by itself.

117

.PP

118

\fBdrizzledump\fR

119

can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it. Buffering in memory can be a problem if you are dumping large tables. To dump tables row by row, use the

120

\fB\-\-quick\fR

121

option (or

122

\fB\-\-opt\fR, which enables

123

\fB\-\-quick\fR). The

124

\fB\-\-opt\fR

125

option (and hence

126

\fB\-\-quick\fR) is enabled by default; to enable memory buffering, use

127

\fB\-\-skip\-quick\fR.

128

.PP

129

If you are using a recent version of

130

\fBdrizzledump\fR

131

to generate a dump to be reloaded into a very old drizzle server, you should not use the

132

\fB\-\-opt\fR

133

134

\fB\-\-extended\-insert\fR

135

option. Use

136

\fB\-\-skip\-opt\fR

137

instead.

138

.PP

139

\fBdrizzledump\fR

140

supports the options in the following list.

141

.TP 3n

142

\(bu

143

\fB\-\-help\fR,

144

\fB\-?\fR

145

.sp

146

Display a help message and exit.

147

.TP 3n

148

\(bu

149

\fB\-\-add\-drop\-database\fR

150

.sp

151

Add a

152

DROP DATABASE

153

statement before each

154

CREATE DATABASE

155

statement.

156

.TP 3n

157

\(bu

158

\fB\-\-add\-drop\-table\fR

159

.sp

160

Add a

161

DROP TABLE

162

statement before each

163

CREATE TABLE

164

statement.

165

.TP 3n

166

\(bu

167

\fB\-\-add\-locks\fR

168

.sp

169

Surround each table dump with

170

LOCK TABLES

171

and

172

UNLOCK TABLES

173

statements. This results in faster inserts when the dump file is reloaded.

174

.TP 3n

175

\(bu

176

\fB\-\-all\-databases\fR,

177

\fB\-A\fR

178

.sp

179

Dump all tables in all databases. This is the same as using the

180

\fB\-\-databases\fR

181

option and naming all the databases on the command line.

182

.TP 3n

183

\(bu

184

\fB\-\-allow\-keywords\fR

185

.sp

186

Allow creation of column names that are keywords. This works by prefixing each column name with the table name.

187

.TP 3n

188

\(bu

189

\fB\-\-apply\-slave\-statements\fR

190

.sp

191

For a slave dump produced with the

192

\fB\-\-dump\-slave\fR

193

option, add a

194

STOP SLAVE

195

statement before the

196

CHANGE MASTER TO

197

statement and a

198

START SLAVE

199

statement at the end of the output.

200

.TP 3n

201

\(bu

202

\fB\-\-character\-sets\-dir=\fR\fB\fIpath\fR\fR

203

.sp

204

The directory where character sets are installed.

205

.TP 3n

206

\(bu

207

\fB\-\-comments\fR,

208

\fB\-i\fR

209

.sp

210

Write additional information in the dump file such as program version, server version, and host. This option is enabled by default. To suppress this additional information, use

211

\fB\-\-skip\-comments\fR.

212

.TP 3n

213

\(bu

214

\fB\-\-compact\fR

215

.sp

216

Produce less verbose output. This option enables the

217

\fB\-\-skip\-add\-drop\-table\fR,

218

\fB\-\-skip\-add\-locks\fR,

219

\fB\-\-skip\-comments\fR,

220

\fB\-\-skip\-disable\-keys\fR, and

221

\fB\-\-skip\-set\-charset\fR

222

options.

223

.TP 3n

224

\(bu

225

\fB\-\-compatible=\fR\fB\fIname\fR\fR

226

.sp

227

Produce output that is more compatible with other database systems or with older drizzle servers. The value of

228

name

229

can be

230

ansi,

231

mysql323,

232

mysql40,

233

postgresql,

234

oracle,

235

mssql,

236

db2,

237

maxdb,

238

no_key_options,

239

no_table_options, or

240

no_field_options. To use several values, separate them by commas. These values have the same meaning as the corresponding options for setting the server SQL mode.

241

.sp

242

This option does not guarantee compatibility with other servers. It only enables those SQL mode values that are currently available for making dump output more compatible. For example,

243

\fB\-\-compatible=oracle\fR

244

does not map data types to Oracle types or use Oracle comment syntax.

245

.sp

246

\fIThis option requires a server version of 4.1.0 or higher\fR. With older servers, it does nothing.

247

.TP 3n

248

\(bu

249

\fB\-\-complete\-insert\fR,

250

\fB\-c\fR

251

.sp

252

Use complete

253

INSERT

254

statements that include column names.

255

.TP 3n

256

\(bu

257

\fB\-\-compress\fR,

258

\fB\-C\fR

259

.sp

260

Compress all information sent between the client and the server if both support compression.

261

.TP 3n

262

\(bu

263

\fB\-\-create\-options\fR

264

.sp

265

Include all drizzle\-specific table options in the

266

CREATE TABLE

267

statements.

268

.TP 3n

269

\(bu

270

\fB\-\-databases\fR,

271

\fB\-B\fR

272

.sp

273

Dump several databases. Normally,

274

\fBdrizzledump\fR

275

treats the first name argument on the command line as a database name and following names as table names. With this option, it treats all name arguments as database names.

276

CREATE DATABASE

277

and

278

USE

279

statements are included in the output before each new database.

280

.TP 3n

281

\(bu

282

\fB\-\-debug[=\fR\fB\fIdebug_options\fR\fR\fB]\fR,

283

\fB\-# [\fR\fB\fIdebug_options\fR\fR\fB]\fR

284

.sp

285

Write a debugging log. A typical

286

\fIdebug_options\fR

287

string is

288

\'d:t:o,\fIfile_name\fR'. The default value is

289

\'d:t:o,/tmp/drizzledump.trace'.

290

.TP 3n

291

\(bu

292

\fB\-\-debug\-check\fR

293

.sp

294

Print some debugging information when the program exits.

295

.TP 3n

296

\(bu

297

\fB\-\-debug\-info\fR

298

.sp

299

Print debugging information and memory and CPU usage statistics when the program exits.

300

.TP 3n

301

\(bu

302

\fB\-\-default\-character\-set=\fR\fB\fIcharset_name\fR\fR

303

.sp

304

Use

305

\fIcharset_name\fR

306

as the default character set. If no character set is specified,

307

\fBdrizzledump\fR

308

uses

309

utf8

310

.sp

311

This option has no effect for output data files produced by using the

312

\fB\-\-tab\fR

313

option. See the description for that option.

314

.TP 3n

315

\(bu

316

\fB\-\-delayed\-insert\fR

317

.sp

318

Write

319

INSERT DELAYED

320

statements rather than

321

INSERT

322

statements.

323

.TP 3n

324

\(bu

325

\fB\-\-delete\-master\-logs\fR

326

.sp

327

On a master replication server, delete the binary logs after performing the dump operation. This option automatically enables

328

\fB\-\-master\-data\fR.

329

.TP 3n

330

\(bu

331

\fB\-\-disable\-keys\fR,

332

\fB\-K\fR

333

.sp

334

For each table, surround the

335

INSERT

336

statements with

337

/*!40000 ALTER TABLE \fItbl_name\fR DISABLE KEYS */;

338

and

339

/*!40000 ALTER TABLE \fItbl_name\fR ENABLE KEYS */;

340

statements. This makes loading the dump file faster because the indexes are created after all rows are inserted. This option is effective only for non\-unique indexes of

341

MyISAM

342

tables.

343

.TP 3n

344

\(bu

345

\fB\-\-dump\-date\fR

346

.sp

347

\fBdrizzledump\fR

348

produces a

349

\-\- Dump completed on \fIDATE\fR

350

comment at the end of the dump if the

351

\fB\-\-comments\fR

352

option is given. However, the date causes dump files for identical data take at different times to appear to be different.

353

\fB\-\-dump\-date\fR

354

and

355

\fB\-\-skip\-dump\-date\fR

356

control whether the date is added to the comment. The default is

357

\fB\-\-dump\-date\fR

358

(include the date in the comment).

359

\fB\-\-skip\-dump\-date\fR

360

suppresses date printing.

361

.TP 3n

362

\(bu

363

\fB\-\-dump\-slave[=\fR\fB\fIvalue\fR\fR\fB]\fR

364

.sp

365

This option is similar to

366

\fB\-\-master\-data\fR

367

except that it is used to dump a replication slave server to produce a dump file that can be used to set up another server as a slave that has the same master as the dumped server. It causes the dump output to include a

368

CHANGE MASTER TO

369

statement that indicates the binary log coordinates (file name and position) of the dumped slave's master (rather than the coordinates of the dumped server, as is done by the

370

\fB\-\-master\-data\fR

371

option). These are the master server coordinates from which the slave should start replicating.

372

.sp

373

The option value is handled the same way as for

374

\fB\-\-master\-data\fR

375

and has the same effect as

376

\fB\-\-master\-data\fR

377

in terms of enabling or disabling other options and in how locking is handled.

378

.sp

379

In conjunction with

380

\fB\-\-dump\-slave\fR, the

381

\fB\-\-apply\-slave\-statements\fR

382

and

383

\fB\-\-include\-master\-host\-port\fR

384

options can also be used.

385

.TP 3n

386

\(bu

387

\fB\-\-events\fR,

388

\fB\-E\fR

389

.sp

390

Dump events from the dumped databases.

391

.TP 3n

392

\(bu

393

\fB\-\-extended\-insert\fR,

394

\fB\-e\fR

395

.sp

396

Use multiple\-row

397

INSERT

398

syntax that include several

399

VALUES

400

lists. This results in a smaller dump file and speeds up inserts when the file is reloaded.

401

.TP 3n

402

\(bu

403

\fB\-\-fields\-terminated\-by=...\fR,

404

\fB\-\-fields\-enclosed\-by=...\fR,

405

\fB\-\-fields\-optionally\-enclosed\-by=...\fR,

406

\fB\-\-fields\-escaped\-by=...\fR

407

.sp

408

These options are used with the

409

\fB\-T\fR

410

option and have the same meaning as the corresponding clauses for

411

LOAD DATA INFILE.

412

.TP 3n

413

\(bu

414

\fB\-\-first\-slave\fR,

415

\fB\-x\fR

416

.sp

417

Deprecated. Now renamed to

418

\fB\-\-lock\-all\-tables\fR.

419

.TP 3n

420

\(bu

421

\fB\-\-flush\-logs\fR,

422

\fB\-F\fR

423

.sp

424

Flush the drizzle server log files before starting the dump. This option requires the

425

RELOAD

426

privilege. Note that if you use this option in combination with the

427

\fB\-\-all\-databases\fR

428

(or

429

\fB\-A\fR) option, the logs are flushed

430

\fIfor each database dumped\fR. The exception is when using

431

\fB\-\-lock\-all\-tables\fR

432

433

\fB\-\-master\-data\fR: In this case, the logs are flushed only once, corresponding to the moment that all tables are locked. If you want your dump and the log flush to happen at exactly the same moment, you should use

434

\fB\-\-flush\-logs\fR

435

together with either

436

\fB\-\-lock\-all\-tables\fR

437

438

\fB\-\-master\-data\fR.

439

.TP 3n

440

\(bu

441

\fB\-\-flush\-privileges\fR

442

.sp

443

Emit a

444

FLUSH PRIVILEGES

445

statement after dumping the

446

drizzle

447

database. This option should be used any time the dump contains the

448

drizzle

449

database and any other database that depends on the data in the

450

drizzle

451

database for proper restoration.

452

.TP 3n

453

\(bu

454

\fB\-\-force\fR,

455

\fB\-f\fR

456

.sp

457

Continue even if an SQL error occurs during a table dump.

458

.sp

459

One use for this option is to cause

460

\fBdrizzledump\fR

461

to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped. Without

462

\fB\-\-force\fR,

463

\fBdrizzledump\fR

464

exits with an error message. With

465

\fB\-\-force\fR,

466

\fBdrizzledump\fR

467

prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing.

468

.TP 3n

469

\(bu

470

\fB\-\-host=\fR\fB\fIhost_name\fR\fR,

471

\fB\-h \fR\fB\fIhost_name\fR\fR

472

.sp

473

Dump data from the drizzle server on the given host. The default host is

474

localhost.

475

.TP 3n

476

\(bu

477

\fB\-\-hex\-blob\fR

478

.sp

479

Dump binary columns using hexadecimal notation (for example,

480

\'abc'

481

becomes

482

0x616263). The affected data types are

483

BINARY,

484

VARBINARY,

485

BLOB, and

486

BIT.

487

.TP 3n

488

\(bu

489

\fB\-\-include\-master\-host\-port\fR

490

.sp

491

For the

492

CHANGE MASTER TO

493

statement in a slave dump produced with the

494

\fB\-\-dump\-slave\fR

495

option, add

496

MASTER_PORT

497

and

498

MASTER_PORT

499

options for the host name and TCP/IP port number of the slave's master.

500

.TP 3n

501

\(bu

502

\fB\-\-ignore\-table=\fR\fB\fIdb_name.tbl_name\fR\fR

503

.sp

504

Do not dump the given table, which must be specified using both the database and table names. To ignore multiple tables, use this option multiple times. This option also can be used to ignore views.

505

.TP 3n

506

\(bu

507

\fB\-\-insert\-ignore\fR

508

.sp

509

Write

510

INSERT

511

statements with the

512

IGNORE

513

option.

514

.TP 3n

515

\(bu

516

\fB\-\-lines\-terminated\-by=...\fR

517

.sp

518

This option is used with the

519

\fB\-T\fR

520

option and has the same meaning as the corresponding clause for

521

LOAD DATA INFILE.

522

.TP 3n

523

\(bu

524

\fB\-\-lock\-all\-tables\fR,

525

\fB\-x\fR

526

.sp

527

Lock all tables across all databases. This is achieved by acquiring a global read lock for the duration of the whole dump. This option automatically turns off

528

\fB\-\-single\-transaction\fR

529

and

530

\fB\-\-lock\-tables\fR.

531

.TP 3n

532

\(bu

533

\fB\-\-lock\-tables\fR,

534

\fB\-l\fR

535

.sp

536

Lock all tables before dumping them. The tables are locked with

537

READ LOCAL

538

to allow concurrent inserts in the case of

539

MyISAM

540

tables. For transactional tables such as

541

InnoDB

542

and

543

BDB,

544

\fB\-\-single\-transaction\fR

545

is a much better option, because it does not need to lock the tables at all.

546

.sp

547

Please note that when dumping multiple databases,

548

\fB\-\-lock\-tables\fR

549

locks tables for each database separately. Therefore, this option does not guarantee that the tables in the dump file are logically consistent between databases. Tables in different databases may be dumped in completely different states.

550

.TP 3n

551

\(bu

552

\fB\-\-log\-error=\fR\fB\fIfile_name\fR\fR

553

.sp

554

Append warnings and errors to the named file.

555

.TP 3n

556

\(bu

557

\fB\-\-master\-data[=\fR\fB\fIvalue\fR\fR\fB]\fR

558

.sp

559

Use this option to dump a master replication server to produce a dump file that can be used to set up another server as a slave of the master. It causes the dump output to include a

560

CHANGE MASTER TO

561

statement that indicates the binary log coordinates (file name and position) of the dumped server. These are the master server coordinates from which the slave should start replicating.

562

.sp

563

If the option value is 2, the

564

CHANGE MASTER TO

565

statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded. If the option value is 1, the statement takes effect when the dump file is reloaded. If the option value is not specified, the default value is 1.

566

.sp

567

This option requires the

568

RELOAD

569

privilege and the binary log must be enabled.

570

.sp

571

The

572

\fB\-\-master\-data\fR

573

option automatically turns off

574

\fB\-\-lock\-tables\fR. It also turns on

575

\fB\-\-lock\-all\-tables\fR, unless

576

\fB\-\-single\-transaction\fR

577

also is specified, in which case, a global read lock is acquired only for a short time at the beginning of the dump (see the description for

578

\fB\-\-single\-transaction\fR). In all cases, any action on logs happens at the exact moment of the dump.

579

.sp

580

It is also possible to set up a slave by dumping an existing slave of the master. To do this, use the

581

\fB\-\-dump\-slave\fR

582

option instead.

583

.TP 3n

584

\(bu

585

\fB\-\-no\-autocommit\fR

586

.sp

587

Enclose the

588

INSERT

589

statements for each dumped table within

590

SET autocommit = 0

591

and

592

COMMIT

593

statements.

594

.TP 3n

595

\(bu

596

\fB\-\-no\-create\-db\fR,

597

\fB\-n\fR

598

.sp

599

This option suppresses the

600

CREATE DATABASE

601

statements that are otherwise included in the output if the

602

\fB\-\-databases\fR

603

604

\fB\-\-all\-databases\fR

605

option is given.

606

.TP 3n

607

\(bu

608

\fB\-\-no\-create\-info\fR,

609

\fB\-t\fR

610

.sp

611

Do not write

612

CREATE TABLE

613

statements that re\-create each dumped table.

614

.TP 3n

615

\(bu

616

\fB\-\-no\-data\fR,

617

\fB\-d\fR

618

.sp

619

Do not write any table row information (that is, do not dump table contents). This is very useful if you want to dump only the

620

CREATE TABLE

621

statement for the table.

622

.TP 3n

623

\(bu

624

\fB\-\-no\-set\-names\fR

625

.sp

626

This option is deprecated. Use

627

\fB\-\-skip\-set\-charset\fR. instead.

628

.TP 3n

629

\(bu

630

\fB\-\-opt\fR

631

.sp

632

This option is shorthand; it is the same as specifying

633

\fB\-\-add\-drop\-table\fR

634

\fB\-\-add\-locks\fR

635

\fB\-\-create\-options\fR

636

\fB\-\-disable\-keys\fR

637

\fB\-\-extended\-insert\fR

638

\fB\-\-lock\-tables\fR

639

\fB\-\-quick\fR

640

\fB\-\-set\-charset\fR. It should give you a fast dump operation and produce a dump file that can be reloaded into a drizzle server quickly.

641

.sp

642

\fIThe \fR\fI\fB\-\-opt\fR\fR\fI option is enabled by default. Use \fR\fI\fB\-\-skip\-opt\fR\fR\fI to disable it.\fR

643

See the discussion at the beginning of this section for information about selectively enabling or disabling certain of the options affected by

644

\fB\-\-opt\fR.

645

.TP 3n

646

\(bu

647

\fB\-\-order\-by\-primary\fR

648

.sp

649

Sorts each table's rows by its primary key, or by its first unique index, if such an index exists. This is useful when dumping a

650

MyISAM

651

table to be loaded into an

652

InnoDB

653

table, but will make the dump itself take considerably longer.

654

.TP 3n

655

\(bu

656

\fB\-\-password[=\fR\fB\fIpassword\fR\fR\fB]\fR,

657

\fB\-p[\fR\fB\fIpassword\fR\fR\fB]\fR

658

.sp

659

The password to use when connecting to the server. If you use the short option form (\fB\-p\fR), you

660

\fIcannot\fR

661

have a space between the option and the password. If you omit the

662

\fIpassword\fR

663

value following the

664

\fB\-\-password\fR

665

666

\fB\-p\fR

667

option on the command line, you are prompted for one.

668

.sp

669

Specifying a password on the command line should be considered insecure.

670

.TP 3n

671

\(bu

672

\fB\-\-pipe\fR,

673

\fB\-W\fR

674

.sp

675

On Windows, connect to the server via a named pipe. This option applies only for connections to a local server, and only if the server supports named\-pipe connections.

676

.TP 3n

677

\(bu

678

\fB\-\-port=\fR\fB\fIport_num\fR\fR,

679

\fB\-P \fR\fB\fIport_num\fR\fR

680

.sp

681

The TCP/IP port number to use for the connection.

682

.TP 3n

683

\(bu

684

\fB\-\-protocol={TCP|SOCKET|PIPE|MEMORY}\fR

685

.sp

686

The connection protocol to use for connecting to the server. It is useful when the other connection parameters normally would cause a protocol to be used other than the one you want.

687

.TP 3n

688

\(bu

689

\fB\-\-quick\fR,

690

\fB\-q\fR

691

.sp

692

This option is useful for dumping large tables. It forces

693

\fBdrizzledump\fR

694

to retrieve rows for a table from the server a row at a time rather than retrieving the entire row set and buffering it in memory before writing it out.

695

.TP 3n

696

\(bu

697

\fB\-\-quote\-names\fR,

698

\fB\-Q\fR

699

.sp

700

Quote database, table, and column names within

701

\(lq`\(rq

702

characters. If the

703

ANSI_QUOTES

704

SQL mode is enabled, names are quoted within

705

\(lq"\(rq

706

characters. This option is enabled by default. It can be disabled with

707

\fB\-\-skip\-quote\-names\fR, but this option should be given after any option such as

708

\fB\-\-compatible\fR

709

that may enable

710

\fB\-\-quote\-names\fR.

711

.TP 3n

712

\(bu

713

\fB\-\-replace\fR

714

.sp

715

Write

716

REPLACE

717

statements rather than

718

INSERT

719

statements.

720

.TP 3n

721

\(bu

722

\fB\-\-result\-file=\fR\fB\fIfile_name\fR\fR,

723

\fB\-r \fR\fB\fIfile_name\fR\fR

724

.sp

725

Direct output to a given file. This option should be used on Windows to prevent newline

726

\(lq\\n\(rq

727

characters from being converted to

728

\(lq\\r\\n\(rq

729

carriage return/newline sequences. The result file is created and its contents overwritten, even if an error occurs while generating the dump. The previous contents are lost.

730

.TP 3n

731

\(bu

732

\fB\-\-routines\fR,

733

\fB\-R\fR

734

.sp

735

Dump stored routines (procedures and functions) from the dumped databases. Use of this option requires the

736

SELECT

737

privilege for the

738

drizzle.proc

739

table. The output generated by using

740

\fB\-\-routines\fR

741

contains

742

CREATE PROCEDURE

743

and

744

CREATE FUNCTION

745

statements to re\-create the routines. However, these statements do not include attributes such as the routine creation and modification timestamps. This means that when the routines are reloaded, they will be created with the timestamps equal to the reload time.

746

.sp

747

If you require routines to be re\-created with their original timestamp attributes, do not use

748

\fB\-\-routines\fR. Instead, dump and reload the contents of the

749

drizzle.proc

750

table directly, using a drizzle account that has appropriate privileges for the

751

drizzle

752

database.

753

.TP 3n

754

\(bu

755

\fB\-\-set\-charset\fR

756

.sp

757

Add

758

SET NAMES \fIdefault_character_set\fR

759

to the output. This option is enabled by default. To suppress the

760

SET NAMES

761

statement, use

762

\fB\-\-skip\-set\-charset\fR.

763

.TP 3n

764

\(bu

765

\fB\-\-single\-transaction\fR

766

.sp

767

This option issues a

768

BEGIN

769

SQL statement before dumping data from the server. It is useful only with transactional tables such as

770

InnoDB, because then it dumps the consistent state of the database at the time when

771

BEGIN

772

was issued without blocking any applications.

773

.sp

774

When using this option, you should keep in mind that only

775

InnoDB

776

and

777

Falcon

778

tables are dumped in a consistent state. For example, any

779

MyISAM

780

781

MEMORY

782

tables dumped while using this option may still change state.

783

.sp

784

While a

785

\fB\-\-single\-transaction\fR

786

dump is in process, to ensure a valid dump file (correct table contents and binary log position), no other connection should use the following statements:

787

ALTER TABLE,

788

DROP TABLE,

789

RENAME TABLE,

790

TRUNCATE TABLE. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the

791

SELECT

792

performed by

793

\fBdrizzledump\fR

794

to retrieve the table contents to obtain incorrect contents or fail.

795

.sp

796

The

797

\fB\-\-single\-transaction\fR

798

option and the

799

\fB\-\-lock\-tables\fR

800

option are mutually exclusive, because

801

LOCK TABLES

802

causes any pending transactions to be committed implicitly.

803

.sp

804

To dump large tables, you should combine this option with

805

\fB\-\-quick\fR.

806

.TP 3n

807

\(bu

808

\fB\-\-skip\-comments\fR

809

.sp

810

See the description for the

811

\fB\-\-comments\fR

812

option.

813

.TP 3n

814

\(bu

815

\fB\-\-skip\-opt\fR

816

.sp

817

See the description for the

818

\fB\-\-opt\fR

819

option.

820

.TP 3n

821

\(bu

822

\fB\-\-socket=\fR\fB\fIpath\fR\fR,

823

\fB\-S \fR\fB\fIpath\fR\fR

824

.sp

825

For connections to

826

localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use.

827

.TP 3n

828

\(bu

829

\fB\-\-ssl*\fR

830

.sp

831

Options that begin with

832

\fB\-\-ssl\fR

833

specify whether to connect to the server via SSL and indicate where to find SSL keys and certificates.

834

.TP 3n

835

\(bu

836

\fB\-\-tab=\fR\fB\fIpath\fR\fR,

837

\fB\-T \fR\fB\fIpath\fR\fR

838

.sp

839

Produce tab\-separated data files. For each dumped table,

840

\fBdrizzledump\fR

841

creates a

842

\fI\fItbl_name\fR\fR\fI.sql\fR

843

file that contains the

844

CREATE TABLE

845

statement that creates the table, and a

846

\fI\fItbl_name\fR\fR\fI.txt\fR

847

file that contains its data. The option value is the directory in which to write the files.

848

.sp

849

By default, the

850

\fI.txt\fR

851

data files are formatted using tab characters between column values and a newline at the end of each line. The format can be specified explicitly using the

852

\fB\-\-fields\-\fR\fB\fIxxx\fR\fR

853

and

854

\fB\-\-lines\-terminated\-by\fR

855

options.

856

.sp

857

Column values are dumped using the

858

binary

859

character set and the

860

\fB\-\-default\-character\-set\fR

861

option is ignored. In effect, there is no character set conversion. If a table contains columns in several character sets, the output data file will as well and you may not be able to reload the file correctly.

862

.sp

863

.it 1 an-trap

864

.nr an-no-space-flag 1

865

.nr an-break-flag 1

866

.br

867

\fBNote\fR

868

This option should be used only when

869

\fBdrizzledump\fR

870

is run on the same machine as the

871

\fBdrizzled\fR

872

server. You must have the

873

FILE

874

privilege, and the server must have permission to write files in the directory that you specify.

875

.TP 3n

876

\(bu

877

\fB\-\-tables\fR

878

.sp

879

Override the

880

\fB\-\-databases\fR

881

882

\fB\-B\fR

883

option.

884

\fBdrizzledump\fR

885

regards all name arguments following the option as table names.

886

.TP 3n

887

\(bu

888

\fB\-\-triggers\fR

889

.sp

890

Dump triggers for each dumped table. This option is enabled by default; disable it with

891

\fB\-\-skip\-triggers\fR.

892

.TP 3n

893

\(bu

894

\fB\-\-tz\-utc\fR

895

.sp

896

This option enables

897

TIMESTAMP

898

columns to be dumped and reloaded between servers in different time zones.

899

\fBdrizzledump\fR

900

sets its connection time zone to UTC and adds

901

SET TIME_ZONE='+00:00'

902

to the dump file. Without this option,

903

TIMESTAMP

904

columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change.

905

\fB\-\-tz\-utc\fR

906

also protects against changes due to daylight saving time.

907

\fB\-\-tz\-utc\fR

908

is enabled by default. To disable it, use

909

\fB\-\-skip\-tz\-utc\fR.

910

.TP 3n

911

\(bu

912

\fB\-\-user=\fR\fB\fIuser_name\fR\fR,

913

\fB\-u \fR\fB\fIuser_name\fR\fR

914

.sp

915

The drizzle user name to use when connecting to the server.

916

.TP 3n

917

\(bu

918

\fB\-\-verbose\fR,

919

\fB\-v\fR

920

.sp

921

Verbose mode. Print more information about what the program does.

922

.TP 3n

923

\(bu

924

\fB\-\-version\fR,

925

\fB\-V\fR

926

.sp

927

Display version information and exit.

928

.TP 3n

929

\(bu

930

\fB\-\-where='\fR\fB\fIwhere_condition\fR\fR\fB'\fR,

931

\fB\-w '\fR\fB\fIwhere_condition\fR\fR\fB'\fR

932

.sp

933

Dump only rows selected by the given

934

WHERE

935

condition. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter.

936

.sp

937

Examples:

938

.sp

939

.RS 3n

940

.nf

941

\-\-where="user='jimf'"

942

\-w"userid>1"

943

\-w"userid<1"

944

.fi

945

.RE

946

.TP 3n

947

\(bu

948

\fB\-\-xml\fR,

949

\fB\-X\fR

950

.sp

951

Write dump output as well\-formed XML.

952

.sp

953

\fBNULL\fR\fB, \fR\fB'NULL'\fR\fB, and Empty Values\fR: For some column named

954

\fIcolumn_name\fR, the

955

NULL

956

value, an empty string, and the string value

957

\'NULL'

958

are distinguished from one another in the output generated by this option as follows.

959

.TS

960

allbox tab(:);

961

l l

962

l l

963

l l

964

l l.

965

966

\fBValue\fR:

967

T}:T{

968

\fBXML Representation\fR:

969

970

971

NULL (\fIunknown value\fR)

972

T}:T{

973

<field name="\fIcolumn_name\fR"

974

xsi:nil="true" />

975

976

977

\'' (\fIempty string\fR)

978

T}:T{

979

980

</field>

981

982

983

\'NULL' (\fIstring value\fR)

984

T}:T{

985

986

NULL

987

</field>

988

989

.TE

990

.sp

991

The output from the

992

\fBdrizzle\fR

993

client when run using the

994

\fB\-\-xml\fR

995

option also follows these rules. (See

996

the section called \(lq\fBMYSQL\fR OPTIONS\(rq.)

997

.sp

998

XML output from

999

\fBdrizzledump\fR

1000

includes the XML namespace, as shown here:

1001

.sp

1002

.RS 3n

1003

.nf

1004

shell> \fBdrizzledump \-\-xml \-u root world City\fR

1005

<?xml version="1.0"?>

1006

1007

1008

<table_structure name="City">

1009

1010

1011

1012

1013

1014

<key Table="City" Non_unique="0" Key_name="PRIMARY" Seq_in_index="1" Column_name="ID" Collation="A" Cardinality="4079"

1015

Null="" Index_type="BTREE" Comment="" />

1016

<options Name="City" Engine="MyISAM" Version="10" Row_format="Fixed" Rows="4079" Avg_row_length="67" Data_length="27329

1017

3" Max_data_length="18858823439613951" Index_length="43008" Data_free="0" Auto_increment="4080" Create_time="2007\-03\-31 01:47:01" Updat

1018

e_time="2007\-03\-31 01:47:02" Collation="latin1_swedish_ci" Create_options="" Comment="" />

1019

</table_structure>

1020

<table_data name="City">

1021

<row>

1022

1023

<field name="Name">Kabul</field>

1024

1025

<field name="District">Kabol</field>

1026

1027

</row>

1028

\fI...\fR

1029

<row>

1030

1031

<field name="Name">Rafah</field>

1032

1033

<field name="District">Rafah</field>

1034

1035

</row>

1036

</table_data>

1037

</database>

1038

</drizzledump>

1039

.fi

1040

.RE

1041

.sp

1042

.sp

1043

.RE

1044

.PP

1045

You can also set the following variables by using

1046

\fB\-\-\fR\fB\fIvar_name\fR\fR\fB=\fR\fB\fIvalue\fR\fR

1047

syntax:

1048

.TP 3n

1049

\(bu

1050

max_allowed_packet

1051

.sp

1052

The maximum size of the buffer for client/server communication. The maximum is 1GB.

1053

.TP 3n

1054

\(bu

1055

net_buffer_length

1056

.sp

1057

The initial size of the buffer for client/server communication. When creating multiple\-row\-insert statements (as with option

1058

\fB\-\-extended\-insert\fR

1059

1060

\fB\-\-opt\fR),

1061

\fBdrizzledump\fR

1062

creates rows up to

1063

net_buffer_length

1064

length. If you increase this variable, you should also ensure that the

1065

net_buffer_length

1066

variable in the drizzle server is at least this large.

1067

.sp

1068

.RE

1069

.PP

1070

The most common use of

1071

\fBdrizzledump\fR

1072

is probably for making a backup of an entire database:

1073

.sp

1074

.RS 3n

1075

.nf

1076

shell> \fBdrizzledump \fR\fB\fIdb_name\fR\fR\fB > \fR\fB\fIbackup\-file.sql\fR\fR

1077

.fi

1078

.RE

1079

.PP

1080

You can read the dump file back into the server like this:

1081

.sp

1082

.RS 3n

1083

.nf

1084

shell> \fBdrizzle \fR\fB\fIdb_name\fR\fR\fB < \fR\fB\fIbackup\-file.sql\fR\fR

1085

.fi

1086

.RE

1087

.PP

1088

Or like this:

1089

.sp

1090

.RS 3n

1091

.nf

1092

shell> \fBdrizzle \-e "source \fR\fB\fI/path\-to\-backup/backup\-file.sql\fR\fR\fB" \fR\fB\fIdb_name\fR\fR

1093

.fi

1094

.RE

1095

.PP

1096

\fBdrizzledump\fR

1097

is also very useful for populating databases by copying data from one drizzle server to another:

1098

.sp

1099

.RS 3n

1100

.nf

1101

shell> \fBdrizzledump \-\-opt \fR\fB\fIdb_name\fR\fR\fB | drizzle \-\-host=\fR\fB\fIremote_host\fR\fR\fB \-C \fR\fB\fIdb_name\fR\fR

1102

.fi

1103

.RE

1104

.PP

1105

It is possible to dump several databases with one command:

1106

.sp

1107

.RS 3n

1108

.nf

1109

shell> \fBdrizzledump \-\-databases \fR\fB\fIdb_name1\fR\fR\fB [\fR\fB\fIdb_name2\fR\fR\fB ...] > my_databases.sql\fR

1110

.fi

1111

.RE

1112

.PP

1113

To dump all databases, use the

1114

\fB\-\-all\-databases\fR

1115

option:

1116

.sp

1117

.RS 3n

1118

.nf

1119

shell> \fBdrizzledump \-\-all\-databases > all_databases.sql\fR

1120

.fi

1121

.RE

1122

.PP

1123

For

1124

InnoDB

1125

tables,

1126

\fBdrizzledump\fR

1127

provides a way of making an online backup:

1128

.sp

1129

.RS 3n

1130

.nf

1131

shell> \fBdrizzledump \-\-all\-databases \-\-single\-transaction > all_databases.sql\fR

1132

.fi

1133

.RE

1134

.PP

1135

This backup acquires a global read lock on all tables (using

1136

FLUSH TABLES WITH READ LOCK) at the beginning of the dump. As soon as this lock has been acquired, the binary log coordinates are read and the lock is released. If long updating statements are running when the

1137

FLUSH

1138

statement is issued, the drizzle server may get stalled until those statements finish. After that, the dump becomes lock\-free and does not disturb reads and writes on the tables. If the update statements that the drizzle server receives are short (in terms of execution time), the initial lock period should not be noticeable, even with many updates.

1139

.PP

1140

For point\-in\-time recovery (also known as

1141

\(lqroll\-forward,\(rq

1142

when you need to restore an old backup and replay the changes that happened since that backup), it is often useful to rotate the binary log , \(lqThe Binary Log\(rq) or at least know the binary log coordinates to which the dump corresponds:

1143

.sp

1144

.RS 3n

1145

.nf

1146

shell> \fBdrizzledump \-\-all\-databases \-\-master\-data=2 > all_databases.sql\fR

1147

.fi

1148

.RE

1149

.PP

1150

Or:

1151

.sp

1152

.RS 3n

1153

.nf

1154

shell> \fBdrizzledump \-\-all\-databases \-\-flush\-logs \-\-master\-data=2\fR

1155

\fB> all_databases.sql\fR

1156

.fi

1157

.RE

1158

.PP

1159

The

1160

\fB\-\-master\-data\fR

1161

and

1162

\fB\-\-single\-transaction\fR

1163

options can be used simultaneously, which provides a convenient way to make an online backup suitable for point\-in\-time recovery if tables are stored using the

1164

InnoDB

1165

storage engine.

1166

.PP

1167

If you encounter problems backing up views, please read the section that covers restrictions on views which describes a workaround for backing up views when this fails due to insufficient privileges.

1168

.SH "COPYRIGHT"

1169

.PP

1170

1171

1172

.PP

1173

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

1174

.PP

1175

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

1176

.PP

1177

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA or see http://www.gnu.org/licenses/.

1178

.SH "SEE ALSO"

1179

For more information, please refer to http://www.drizzle.org/wiki.

1180

.SH AUTHOR

1181

Sun Microsystems, Inc. (http://www.mysql.com/), Drizzle Team

Older »