heroku-api-postgres

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #golang #machine-learning #docker #java #awesome #kubernetes #pytorch #security #open-source

heroku-api-postgres

(★ 14)

A Ruby library to invoke Heroku Postgres APIs

heroku-api-postgres 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Heroku::Api::Postgres

**This gem is unmantained since I migrated everything to https://deplo.io.**
**If you want to maintain it, write me an email.**

Ruby library to invoke Heroku Postgres APIs.
An extension to the official [Platform API](https://github.com/heroku/platform-api) gem to introduce the missing APIs for Postgres.

**This gem is not officialy supported**. We use the same APIs that the offical Heroku Toolbelt uses,
therefore is unrealistic that a breaking change in the APIs would break it, since it means it would break
both this gem and the official Heroku CLI.

Not all APIs are implemented at the moment but we are working hard on implementing all of them.

Please check the [list of implemented and not implemented services](docs/services.md).

Contributes and Pull Requests are welcome!

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'heroku-api-postgres'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install heroku-api-postgres

## Usage

This gem client needs to be instantiated in a similar way to the [PlatformAPI](https://github.com/heroku/platform-api).
You can use the same oauth key or API key that you use for the PlatformAPI.

```ruby
postgres_api_client = Heroku::Api::Postgres.connect(ENV['HEROKU_API_KEY'])
```

```ruby
postgres_api_client = Heroku::Api::Postgres.connect_oauth(ENV['HEROKU_OAUTH_TOKEN'])
```

Look into [Models](docs/models.md) for a detailed description of the JSON objects returned by the APIs.
Those are the bare objects returned by the official Heroku API.

### Databases

```ruby
databases_client = postgres_api_client.databases
```

---

```ruby
database_info = databases_client.info(database_id)
```

returns a [Database](docs/models.md#database).

---

```ruby
database = postgres_api_client.databases.wait(database_id, wait_interval: 5)
```

Waits for the given database to be ready.

Polls every `wait_interval` seconds (default 3).

### Credentials

```ruby
credentials_client = postgres_api_client.credentials
```

---

```ruby
credentials_client.rotate(database_id)
```

Rotate the database credentials.

### Backups

```ruby
backups_client = postgres_api_client.backups
```

---

```ruby
backups = backups_client.info(app_id, backup_id)
```

returns a [Backup](docs/models.md#backup).

---

```ruby
backups = backups_client.list(app_id)
```

returns an array of [Backup](docs/models.md#backup).

The app_id can be either the name of your heroku app or the id.

[Check official API](https://devcenter.heroku.com/articles/platform-api-reference#app)

To retrieve the APP_ID and DATABASE_ID needed to run the tests you can use the name of the app as APP_ID and execute:
`heroku addons --json --app YOUR_APP` to retrieve the DATABASE_ID.

---

```ruby
schedules = backups_client.schedules(database_id)
```

Returns all the backup schedules associated with the database.

Returns an array of [Schedule](docs/models.md#schedule)

---

```ruby
schedule = backups_client.schedule(database_id)
```

Schedules the backups at 00:00 UTC.

Returns a [Schedule](docs/models.md#schedule)

---

```ruby
backup = backups_client.capture(database_id)
```
Captures a new backup for the given database

Returns a [Backup](docs/models.md#backup)

```ruby
backup_url = backups_client.url(app_id, backup_num)
```
Returns a temporary, public accessible URL to download a backup.
Needs the `num` attribute of a Backup.

Returns a [BackupUrl](docs/models.md#backup_url)

---

```ruby
backup = backups_client.restore(database_id, dump_url)
```
Restores a dump from a public URL.

Returns a [Backup](docs/models.md#backup)

---

```ruby
backup = postgres_api_client.backups.wait(app_id, backup_id, wait_interval: 5)
```
Waits for the given backup/restore to be ready.

Polls every `wait_interval` seconds (default 3).

You can pass a block to be executed at each interval:

```ruby
backup = postgres_api_client.backups.wait(app_id, backup_id) do |info|
    puts "Processed #{info[:processed_bytes]} bytes"
end
```

### How do I get the database_id ?
You can obtain a database id by calling the Heroku Platform API

```ruby
heroku = PlatformAPI.connect_oauth(ENV['HEROKU_OAUTH_TOKEN'])
addons = heroku.addon.list
databases = addons.select { |addon| addon['addon_service']['name'] == 'heroku-postgresql' }
databases_ids = databases.map{ |addon| addon['id'] }
```

Check also the [Official API](https://devcenter.heroku.com/articles/platform-api-reference#add-on)

## Development

After checking out the repo, run `bin/setup` to install dependencies.
Then, run `rake spec` to run the tests.
You can run `bin/check` to run linter and the tests together.
You can also run `bin/console` for an interactive prompt that will allow you to experiment.

You need some app and database ids to run the tests and record the cassettes.
In particular you need an app with a postgres database on the free plan and one with a database on a pro plan.

To install this gem onto your local machine, run `bundle exec rake install`.
To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
which will create a git tag for the version, push git commits and tags,
and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/coorasse/heroku-api-postgres.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

heroku-api-postgres

heroku-api-postgres 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

heroku-api-postgres

heroku-api-postgres 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README