57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# `pg_libphonenumber`
|
|
|
|
A (partially implemented!) PostgreSQL extension that provides access to
|
|
[Google's `libphonenumber`](https://github.com/googlei18n/libphonenumber)
|
|
|
|
## Project status
|
|
|
|
This extension is in an **alpha** state. It's not complete or tested enough for
|
|
critical production deployments, but with a little help, we should be able to
|
|
get it there.
|
|
|
|
## Synopsis
|
|
|
|
```sql
|
|
CREATE EXTENSION pg_libphonenumber;
|
|
SELECT parse_phone_number('03 7010 1234', 'AU');
|
|
SELECT parse_phone_number('2819010011', 'US');
|
|
|
|
CREATE TABLE foo ( ph phone_number );
|
|
|
|
-- DO NOT RELY ON THIS
|
|
-- may not always this work way with implicit cast.
|
|
SELECT '2819010011'::phone_number; -- assumes US
|
|
```
|
|
|
|
## Installation
|
|
|
|
### Debian/Ubuntu
|
|
|
|
First you'll need to install `libphonenumber-dev` and the corresponding
|
|
`postgresql-server-dev` package.
|
|
|
|
```shell-script
|
|
sudo apt-get update && sudo apt-get install \
|
|
build-essential \
|
|
postgresql-server-dev-9.6 \
|
|
libphonenumber-dev
|
|
```
|
|
|
|
Then clone this repository and build.
|
|
|
|
```shell-script
|
|
git clone https://github.com/blm768/pg-libphonenumber
|
|
cd pg-libphonenumber
|
|
make
|
|
sudo make install
|
|
```
|
|
|
|
## Running tests
|
|
|
|
For convenience, we provide a Docker image that sets up a test environment.
|
|
|
|
```shell-script
|
|
make docker-image
|
|
docker run -it pg_libphonenumber
|
|
```
|