~ubuntu-branches/ubuntu/hardy/postgresql-8.4/hardy-backports

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

132

133

<para>

134

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

135

Column names can be specified only in conjunction with

136

the <option>--analyze</option> option.

137

</para>

138

<tip>

139

<para>

140

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

141

from the shell. (See examples below.)

142

</para>

143

</tip>

144

</listitem>

145

</varlistentry>

146

147

148

149

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

150

151

<para>

152

Print detailed information during processing.

153

</para>

154

</listitem>

155

</varlistentry>

156

157

158

159

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

160

161

<para>

162

Calculate statistics for use by the optimizer.

163

</para>

164

</listitem>

165

</varlistentry>

166

167

168

169

<term><option>--freeze</option></term>

170

171

<para>

172

Aggressively <quote>freeze</quote> tuples.

173

</para>

174

</listitem>

175

</varlistentry>

176

</variablelist>

177

</para>

178

179

<para>

180

<application>vacuumdb</application> also accepts

181

the following command-line arguments for connection parameters:

182

183

184

185

186

187

188

<para>

189

Specifies the host name of the machine on which the

190

server

191

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

192

as the directory for the Unix domain socket.

193

</para>

194

</listitem>

195

</varlistentry>

196

197

198

199

200

201

<para>

202

Specifies the TCP port or local Unix domain socket file

203

extension on which the server

204

is listening for connections.

205

</para>

206

</listitem>

207

</varlistentry>

208

209

210

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

211

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

212

213

<para>

214

User name to connect as.

215

</para>

216

</listitem>

217

</varlistentry>

218

219

220

221

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

222

223

<para>

224

Never issue a password prompt. If the server requires

225

password authentication and a password is not available by

226

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

227

connection attempt will fail. This option can be useful in

228

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

229

password.

230

</para>

231

</listitem>

232

</varlistentry>

233

234

235

236

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

237

238

<para>

239

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

240

password before connecting to a database.

241

</para>

242

243

<para>

244

This option is never essential, since

245

<application>vacuumdb</application> will automatically prompt

246

for a password if the server demands password authentication.

247

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

248

connection attempt finding out that the server wants a password.

249

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

250

connection attempt.

251

</para>

252

</listitem>

253

</varlistentry>

254

</variablelist>

255

</para>

256

</refsect1>

257

258

259

260

<title>Environment</title>

261

262

263

264

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

265

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

266

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

267

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

268

269

270

<para>

271

Default connection parameters

272

</para>

273

</listitem>

274

</varlistentry>

275

</variablelist>

276

277

<para>

278

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

279

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

280

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

281

</para>

282

283

</refsect1>

284

285

286

287

<title>Diagnostics</title>

288

289

<para>

290

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

291

endterm="sql-vacuum-title"> and <xref linkend="APP-PSQL"> for

292

discussions of potential problems and error messages.

293

The database server must be running at the

294

targeted host. Also, any default connection settings and environment

295

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

296

library will apply.

297

</para>

298

299

</refsect1>

300

301

302

303

<title>Notes</title>

304

305

<para>

306

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

307

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

308

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

309

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

310

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

311

</para>

312

</refsect1>

313

314

315

<title>Examples</title>

316

317

<para>

318

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

319

320

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

321

</screen>

322

</para>

323

324

<para>

325

To clean and analyze for the optimizer a database named

326

<literal>bigdb</literal>:

327

328

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

329

</screen>

330

</para>

331

332

<para>

333

To clean a single table

334

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

335

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

336

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

337

338

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

339

</screen>

340

</para>

341

342

</refsect1>

343

344

345

346

347

348

349

</simplelist>

350

</refsect1>

351

352

</refentry>

Older »