Skip to content

Commit 2eca281

Browse files
fomichev3000asmyasnikov
authored andcommitted
update readme
1 parent 8f6af44 commit 2eca281

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
YDB PHP SDK provides access to Yandex Database cloud services from PHP code.
1+
YDB PHP SDK provides access to [https://ydb.tech/](YDB) from PHP code.
22

3-
Yandex Database is a distributed fault-tolerant DBMS with high availability and scalability, strict consistency and ACID. An SQL dialect – YQL – is used for queries.
3+
YDB is a open-source distributed fault-tolerant DBMS with high availability and scalability, strict consistency and ACID. An SQL dialect – YQL – is used for queries.
44

5-
Yandex Database is available in two modes:
5+
YDB is available in several modes:
66

7-
- Serverless computing mode (only performed operations are paid);
8-
- Dedicated instance mode (dedicated computing resources are paid).
7+
- On-prem installation (is not supported by this SDK yet);
8+
- Serverless computing mode in YC (only performed operations are paid);
9+
- Dedicated instance mode in YC (dedicated computing resources are paid).
910

1011
# Documentation
1112

12-
[https://cloud.yandex.ru/docs/ydb/](https://cloud.yandex.ru/docs/ydb/)
13+
[https://ydb.tech/docs/](https://ydb.tech/docs/)
1314

1415
# Installation
1516

@@ -23,9 +24,9 @@ composer require ydb-platform/ydb-php-sdk
2324

2425
# Connection
2526

26-
First, create a database using [Yandex Cloud Console](https://cloud.yandex.ru/docs/ydb/quickstart/create-db).
27+
First, create a database using [Yandex Cloud Console](https://cloud.yandex.com/docs/ydb/quickstart/create-db).
2728

28-
Yandex Database supports the following authentication methods:
29+
YDB supports the following authentication methods:
2930

3031
- OAuth token
3132
- JWT + private key
@@ -34,7 +35,7 @@ Yandex Database supports the following authentication methods:
3435

3536
## OAuth token
3637

37-
You should obtain [a new OAuth token](https://cloud.yandex.ru/docs/iam/concepts/authorization/oauth-token).
38+
You should obtain [a new OAuth token](https://cloud.yandex.com/docs/iam/concepts/authorization/oauth-token).
3839

3940
Use your OAuth token:
4041

@@ -70,7 +71,7 @@ $ydb = new Ydb($config);
7071

7172
## JWT + private key
7273

73-
Create [a service account](https://cloud.yandex.ru/docs/iam/operations/sa/create) with the `editor` role, then create a private key. Also you need a key ID and a service account ID.
74+
Create [a service account](https://cloud.yandex.com/docs/iam/operations/sa/create) with the `editor` role, then create a private key. Also you need a key ID and a service account ID.
7475

7576
Connect to your database:
7677

@@ -101,9 +102,9 @@ $ydb = new Ydb($config);
101102

102103
## JWT + JSON file
103104

104-
Create [a service account](https://cloud.yandex.ru/docs/iam/operations/sa/create) with the `editor` role.
105+
Create [a service account](https://cloud.yandex.com/docs/iam/operations/sa/create) with the `editor` role.
105106

106-
Create a service account [JSON file](https://cloud.yandex.ru/docs/iam/operations/iam-token/create-for-sa#via-cli), save it in your project as `sa_name.json`.
107+
Create a service account [JSON file](https://cloud.yandex.com/docs/iam/operations/iam-token/create-for-sa#via-cli), save it in your project as `sa_name.json`.
107108

108109
Connect to your database:
109110

@@ -131,7 +132,7 @@ $ydb = new Ydb($config);
131132

132133
## Metadata URL
133134

134-
When you deploy a project to VM or function at Yandex.Cloud, you are able to connect to the database using [Metadata URL](https://cloud.yandex.ru/docs/compute/operations/vm-connect/auth-inside-vm). Before you start, you should link your service account to an existing or new VM or function.
135+
When you deploy a project to VM or function at Yandex.Cloud, you are able to connect to the database using [Metadata URL](https://cloud.yandex.com/docs/compute/operations/vm-connect/auth-inside-vm). Before you start, you should link your service account to an existing or new VM or function.
135136

136137
```php
137138
<?php
@@ -233,7 +234,7 @@ Methods of the query builder:
233234
- `collectStats(int $value)` - collect stats (default: 1)
234235
- `parameters(array $parameters)` - parameters
235236
- `operationParams(\Ydb\Operations\OperationParams $operation_params)` - operation params
236-
- `beginTx(string $mode)` - begin a transaction with the given [mode](https://cloud.yandex.ru/docs/ydb/concepts/transactions):
237+
- `beginTx(string $mode)` - begin a transaction with the given [mode](https://ydb.tech/en/docs/concepts/transactions):
237238
- stale
238239
- online
239240
- online_inconsistent

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ydb-platform/ydb-php-sdk",
3-
"description": "Yandex Database SDK (PHP)",
3+
"description": "YDB PHP SDK",
44
"license": "Apache-2.0",
55
"authors": [
66
{

0 commit comments

Comments
 (0)