Skip to content

Commit 386792d

Browse files
committed
docs: add manpage for pgvector-python
1 parent 8bd3c61 commit 386792d

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

doc/python3-pgvector.1

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.\" Manpage for python3-pgvector
2+
.TH PYTHON3-PGVECTOR 1 "2026-02-09" "0.4.2" "User Commands"
3+
.SH NAME
4+
python3-pgvector \- pgvector support for Python
5+
.SH SYNOPSIS
6+
.B import pgvector
7+
.SH DESCRIPTION
8+
.B python3-pgvector
9+
provides support for the pgvector PostgreSQL extension in Python.
10+
It integrates with popular database libraries including Django,
11+
SQLAlchemy, SQLModel, Psycopg (2 and 3), asyncpg, pg8000, and Peewee.
12+
.SH USAGE
13+
Basic usage typically involves registering the vector type with your
14+
database driver and defining models with vector fields.
15+
.SS Psycopg 3
16+
.EX
17+
from pgvector.psycopg import register_vector
18+
register_vector(conn)
19+
.EE
20+
.SS SQLAlchemy
21+
.EX
22+
from pgvector.sqlalchemy import Vector
23+
class Item(Base):
24+
embedding = mapped_column(Vector(3))
25+
.EE
26+
.SH EXAMPLES
27+
Detailed examples for all supported frameworks (Django, SQLAlchemy, etc.)
28+
are available in the Debian documentation directory:
29+
.IP
30+
.B /usr/share/doc/python3-pgvector/examples/
31+
.SH NOTES
32+
The SQLModel tests are currently disabled in the Debian build due to
33+
API incompatibilities with the current sqlmodel package.
34+
.SH SEE ALSO
35+
.BR postgres (1),
36+
.BR psycopg (3)
37+
.SH AUTHOR
38+
This manpage was written for the Debian project by Arian Ott <arian.ott@ieee.org>.

0 commit comments

Comments
 (0)