Skip to content

Commit ef2650c

Browse files
committed
docs: add ltree type to README and integration documentations
1 parent c9c075f commit ef2650c

File tree

5 files changed

+33
-16
lines changed

5 files changed

+33
-16
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ This package provides comprehensive Doctrine support for PostgreSQL features:
5858
- **Range Types**
5959
- Date and time ranges (`daterange`, `tsrange`, `tstzrange`)
6060
- Numeric ranges (`numrange`, `int4range`, `int8range`)
61+
- [ltree](https://www.postgresql.org/docs/current/ltree.html) data type (`ltree`)
6162

6263
### PostgreSQL Operators
6364
- **Array Operations**

docs/AVAILABLE-TYPES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@
2525
| numrange | numrange | `MartinGeorgiev\Doctrine\DBAL\Types\NumRange` |
2626
| tsrange | tsrange | `MartinGeorgiev\Doctrine\DBAL\Types\TsRange` |
2727
| tstzrange | tstzrange | `MartinGeorgiev\Doctrine\DBAL\Types\TstzRange` |
28+
| ltree | ltree | `MartinGeorgiev\Doctrine\DBAL\Types\Ltree` |

docs/INTEGRATING-WITH-DOCTRINE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Type::addType('int8range', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Int8Range");
3838
Type::addType('numrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\NumRange");
3939
Type::addType('tsrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\TsRange");
4040
Type::addType('tstzrange', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\TstzRange");
41+
42+
Type::addType('ltree', "MartinGeorgiev\\Doctrine\\DBAL\\Types\\Ltree");
4143
```
4244

4345

@@ -251,6 +253,8 @@ $platform->registerDoctrineTypeMapping('int8range','int8range');
251253
$platform->registerDoctrineTypeMapping('numrange','numrange');
252254
$platform->registerDoctrineTypeMapping('tsrange','tsrange');
253255
$platform->registerDoctrineTypeMapping('tstzrange','tstzrange');
256+
257+
$platform->registerDoctrineTypeMapping('ltree','ltree');
254258
...
255259

256260
```

docs/INTEGRATING-WITH-LARAVEL.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,18 @@ return [
2525
'_int4' => 'integer[]',
2626
'bigint[]' => 'bigint[]',
2727
'_int8' => 'bigint',
28-
28+
2929
'double precision[]' => 'double precision[]',
3030
'_float8' => 'double precision[]',
3131
'real[]' => 'real[]',
3232
'_float4' => 'real',
33-
33+
3434
'_text' => 'text[]',
3535
'text[]' => 'text[]',
3636
'jsonb' => 'jsonb',
3737
'_jsonb' => 'jsonb[]',
3838
'jsonb[]' => 'jsonb[]',
39-
39+
4040
'cidr' => 'cidr',
4141
'cidr[]' => 'cidr[]',
4242
'_cidr' => 'cidr[]',
@@ -46,10 +46,12 @@ return [
4646
'macaddr' => 'macaddr',
4747
'macaddr[]' => 'macaddr[]',
4848
'_macaddr' => 'macaddr[]',
49-
49+
5050
'point' => 'point',
5151
'point[]' => 'point[]',
5252
'_point' => 'point[]',
53+
54+
'ltree' => 'ltree',
5355
],
5456
],
5557
],
@@ -70,23 +72,25 @@ return [
7072
'bigint[]' => MartinGeorgiev\Doctrine\DBAL\Types\BigIntArray::class,
7173
'integer[]' => MartinGeorgiev\Doctrine\DBAL\Types\IntegerArray::class,
7274
'smallint[]' => MartinGeorgiev\Doctrine\DBAL\Types\SmallIntArray::class,
73-
75+
7476
'double precision[]' => MartinGeorgiev\Doctrine\DBAL\Types\DoublePrecisionArray::class,
7577
'real[]' => MartinGeorgiev\Doctrine\DBAL\Types\RealArray::class,
76-
78+
7779
'text[]' => MartinGeorgiev\Doctrine\DBAL\Types\TextArray::class,
7880
'jsonb' => MartinGeorgiev\Doctrine\DBAL\Types\Jsonb::class,
7981
'jsonb[]' => MartinGeorgiev\Doctrine\DBAL\Types\JsonbArray::class,
80-
82+
8183
'cnet' => MartinGeorgiev\Doctrine\DBAL\Types\Cnet::class,
8284
'cnet[]' => MartinGeorgiev\Doctrine\DBAL\Types\CnetArray::class,
8385
'inet' => MartinGeorgiev\Doctrine\DBAL\Types\Inet::class,
8486
'inet[]' => MartinGeorgiev\Doctrine\DBAL\Types\InetArray::class,
8587
'macaddr' => MartinGeorgiev\Doctrine\DBAL\Types\Macaddr::class,
8688
'macaddr[]' => MartinGeorgiev\Doctrine\DBAL\Types\MacaddrArray::class,
87-
89+
8890
'point' => MartinGeorgiev\Doctrine\DBAL\Types\Point::class,
8991
'point[]' => MartinGeorgiev\Doctrine\DBAL\Types\PointArray::class,
92+
93+
'ltree' => MartinGeorgiev\Doctrine\DBAL\Types\Ltree::class,
9094
],
9195
];
9296
```
@@ -201,7 +205,7 @@ return [
201205
'NUMRANGE' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Numrange::class,
202206
'TSRANGE' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Tsrange::class,
203207
'TSTZRANGE' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Tstzrange::class,
204-
208+
205209
# Arithmetic functions
206210
'CBRT' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Cbrt::class,
207211
'CEIL' => MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Ceil::class,
@@ -340,6 +344,9 @@ class DoctrineEventSubscriber implements Subscriber
340344
if (!Type::hasType('point[]')) {
341345
Type::addType('point[]', \MartinGeorgiev\Doctrine\DBAL\Types\PointArray::class);
342346
}
347+
if (!Type::hasType('ltree')) {
348+
Type::addType('ltree', \MartinGeorgiev\Doctrine\DBAL\Types\Ltree::class);
349+
}
343350
}
344351
}
345352
```

docs/INTEGRATING-WITH-SYMFONY.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ doctrine:
1414
smallint[]: MartinGeorgiev\Doctrine\DBAL\Types\SmallIntArray
1515
integer[]: MartinGeorgiev\Doctrine\DBAL\Types\IntegerArray
1616
bigint[]: MartinGeorgiev\Doctrine\DBAL\Types\BigIntArray
17-
17+
1818
double precision[]: MartinGeorgiev\Doctrine\DBAL\Types\DoublePrecisionArray
1919
real[]: MartinGeorgiev\Doctrine\DBAL\Types\RealArray
20-
20+
2121
text[]: MartinGeorgiev\Doctrine\DBAL\Types\TextArray
2222
jsonb: MartinGeorgiev\Doctrine\DBAL\Types\Jsonb
2323
jsonb[]: MartinGeorgiev\Doctrine\DBAL\Types\JsonbArray
24-
24+
2525
cidr: MartinGeorgiev\Doctrine\DBAL\Types\Cidr
2626
cidr[]: MartinGeorgiev\Doctrine\DBAL\Types\CidrArray
2727
inet: MartinGeorgiev\Doctrine\DBAL\Types\Inet
@@ -31,6 +31,8 @@ doctrine:
3131

3232
point: MartinGeorgiev\Doctrine\DBAL\Types\Point
3333
point[]: MartinGeorgiev\Doctrine\DBAL\Types\PointArray
34+
35+
ltree: MartinGeorgiev\Doctrine\DBAL\Types\Ltree
3436
```
3537
3638
@@ -55,18 +57,18 @@ doctrine:
5557
_int4: integer[]
5658
bigint[]: bigint[]
5759
_int8: bigint[]
58-
60+
5961
double precision[]: double precision[]
6062
_float8: double precision[]
6163
real[]: real[]
6264
_float4: real[]
63-
65+
6466
text[]: text[]
6567
_text: text[]
6668
jsonb: jsonb
6769
jsonb[]: jsonb[]
6870
_jsonb: jsonb[]
69-
71+
7072
cidr: cidr
7173
cidr[]: cidr[]
7274
_cidr: cidr[]
@@ -80,6 +82,8 @@ doctrine:
8082
point: point
8183
point[]: point[]
8284
_point: point[]
85+
86+
ltree: ltree
8387
```
8488

8589

@@ -195,7 +199,7 @@ doctrine:
195199
NUMRANGE: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Numrange
196200
TSRANGE: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Tsrange
197201
TSTZRANGE: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Tstzrange
198-
202+
199203
# Arithmetic functions
200204
CBRT: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Cbrt
201205
CEIL: MartinGeorgiev\Doctrine\ORM\Query\AST\Functions\Ceil

0 commit comments

Comments
 (0)