~ubuntu-branches/ubuntu/oneiric/postgresql-9.1/oneiric-security

<term><option>--table=<replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]</option></term>

145

146

<para>

147

Clean or analyze <replaceable class="parameter">table</replaceable> only.

148

Column names can be specified only in conjunction with

149

the <option>--analyze</option> or <option>--analyze-only</option> options.

150

</para>

151

<tip>

152

<para>

153

If you specify columns, you probably have to escape the parentheses

154

from the shell. (See examples below.)

155

</para>

156

</tip>

157

</listitem>

158

</varlistentry>

159

160

161

162

<term><option>--verbose</option></term>

163

164

<para>

165

Print detailed information during processing.

166

</para>

167

</listitem>

168

</varlistentry>

169

170

171

172

<term><option>--version</></term>

173

174

<para>

175

Print the <application>vacuumdb</application> version and exit.

176

</para>

177

</listitem>

178

</varlistentry>

179

180

181

182

<term><option>--analyze</option></term>

183

184

<para>

185

Also calculate statistics for use by the optimizer.

186

</para>

187

</listitem>

188

</varlistentry>

189

190

191

192

<term><option>--analyze-only</option></term>

193

194

<para>

195

Only calculate statistics for use by the optimizer (no vacuum).

196

</para>

197

</listitem>

198

</varlistentry>

199

200

201

202

203

204

<para>

205

Show help about <application>vacuumdb</application> command line

206

arguments, and exit.

207

</para>

208

</listitem>

209

</varlistentry>

210

211

</variablelist>

212

</para>

213

214

<para>

215

<application>vacuumdb</application> also accepts

216

the following command-line arguments for connection parameters:

217

218

219

220

221

222

<para>

223

Specifies the host name of the machine on which the server

224

is running. If the value begins with a slash, it is used

225

as the directory for the Unix domain socket.

226

</para>

227

</listitem>

228

</varlistentry>

229

230

231

232

233

234

<para>

235

Specifies the TCP port or local Unix domain socket file

236

extension on which the server

237

is listening for connections.

238

</para>

239

</listitem>

240

</varlistentry>

241

242

243

<term><option>-U <replaceable class="parameter">username</replaceable></></term>

244

<term><option>--username=<replaceable class="parameter">username</replaceable></></term>

245

246

<para>

247

User name to connect as.

248

</para>

249

</listitem>

250

</varlistentry>

251

252

253

254

<term><option>--no-password</></term>

255

256

<para>

257

Never issue a password prompt. If the server requires

258

password authentication and a password is not available by

259

other means such as a <filename>.pgpass</filename> file, the

260

connection attempt will fail. This option can be useful in

261

batch jobs and scripts where no user is present to enter a

262

password.

263

</para>

264

</listitem>

265

</varlistentry>

266

267

268

269

<term><option>--password</></term>

270

271

<para>

272

Force <application>vacuumdb</application> to prompt for a

273

password before connecting to a database.

274

</para>

275

276

<para>

277

This option is never essential, since

278

<application>vacuumdb</application> will automatically prompt

279

for a password if the server demands password authentication.

280

However, <application>vacuumdb</application> will waste a

281

connection attempt finding out that the server wants a password.

282

In some cases it is worth typing <option>-W</> to avoid the extra

283

connection attempt.

284

</para>

285

</listitem>

286

</varlistentry>

287

</variablelist>

288

</para>

289

</refsect1>

290

291

292

293

<title>Environment</title>

294

295

296

297

<term><envar>PGDATABASE</envar></term>

298

<term><envar>PGHOST</envar></term>

299

<term><envar>PGPORT</envar></term>

300

<term><envar>PGUSER</envar></term>

301

302

303

<para>

304

Default connection parameters

305

</para>

306

</listitem>

307

</varlistentry>

308

</variablelist>

309

310

<para>

311

This utility, like most other <productname>PostgreSQL</> utilities,

312

also uses the environment variables supported by <application>libpq</>

313

(see <xref linkend="libpq-envars">).

314

</para>

315

316

</refsect1>

317

318

319

320

<title>Diagnostics</title>

321

322

<para>

323

In case of difficulty, see <xref linkend="SQL-VACUUM">

324

and <xref linkend="APP-PSQL"> for

325

discussions of potential problems and error messages.

326

The database server must be running at the

327

targeted host. Also, any default connection settings and environment

328

variables used by the <application>libpq</application> front-end

329

library will apply.

330

</para>

331

332

</refsect1>

333

334

335

336

<title>Notes</title>

337

338

<para>

339

<application>vacuumdb</application> might need to connect several

340

times to the <productname>PostgreSQL</productname> server, asking

341

for a password each time. It is convenient to have a

342

<filename>~/.pgpass</> file in such cases. See <xref

343

linkend="libpq-pgpass"> for more information.

344

</para>

345

</refsect1>

346

347

348

<title>Examples</title>

349

350

<para>

351

To clean the database <literal>test</literal>:

352

353

<prompt>$ </prompt><userinput>vacuumdb test</userinput>

354

</screen>

355

</para>

356

357

<para>

358

To clean and analyze for the optimizer a database named

359

<literal>bigdb</literal>:

360

361

<prompt>$ </prompt><userinput>vacuumdb --analyze bigdb</userinput>

362

</screen>

363

</para>

364

365

<para>

366

To clean a single table

367

<literal>foo</literal> in a database named

368

<literal>xyzzy</literal>, and analyze a single column

369

<literal>bar</literal> of the table for the optimizer:

370

371

<prompt>$ </prompt><userinput>vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy</userinput>

372

</screen>

373

</para>

374

375

</refsect1>

376

377

378

379

380

381

382

</simplelist>

383

</refsect1>

384

385

</refentry>

Older »