Skip to content

Commit

Permalink
ServerStatusInformation -> ServerStatusInfo
Browse files Browse the repository at this point in the history
  • Loading branch information
pluma4345 committed Jan 6, 2025
1 parent 579a367 commit b6c2aac
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 37 deletions.
83 changes: 48 additions & 35 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,38 +14,7 @@ This driver uses semantic versioning:
- A change in the major version (e.g. 1.Y.Z -> 2.0.0) indicates _breaking_
changes that require changes in your code to upgrade.

## [9.3.0] - 2025-01-06

### Added

- Added `db.compact` method (DE-906)

- Added `db.engineStats` method (DE-932)

- Added `db.getLicense` and `db.setLicense` methods (DE-949)

- Added `db.listQueryCacheEntries` method (DE-149)

- Added `db.clearQueryCache` method (DE-148)

- Added `db.getQueryCacheProperties` method (DE-150)

- Added `db.setQueryCacheProperties` method (DE-151)

- Added `collection.shards` method (DE-939)

- Added support for `mdi-prefixed` indexes (DE-956)

- Restored `fulltext` index type support (DE-957)

The `fulltext` index type is still no longer supported for creating new
indexes but can be used to cast existing indexes from `Index`.

- Added support for `edge` indexes (DE-958)

The `Index` type now can also be cast to the `EdgeIndex` type.

## [10.0.0-rc.0] - 2024-12-10
## [Unreleased]

This is a major release and breaks backwards compatibility.

Expand Down Expand Up @@ -244,7 +213,8 @@ for upgrading your code to arangojs v10.

The following types were moved: `QueryOptions`, `ExplainOptions`,
`ExplainPlan`, `ExplainStats`, `SingleExplainResult`, `MultiExplainResult`,
`AstNode`, `ParseResult`, `QueryOptimizerRule`, `QueryTracking`,
`AstNode`, `ParseResult`, `QueryCachePropertiesOptions`, `QueryCacheEntry`,
`QueryCacheProperties`, `QueryOptimizerRule`, `QueryTracking`,
`QueryTrackingOptions`, `QueryInfo` and `AqlUserFunction`.

- Moved service related types from `arangojs/database` module to new
Expand All @@ -268,7 +238,10 @@ for upgrading your code to arangojs v10.
- Moved server administration related types from `arangojs/database` module to
new `arangojs/administration` module

The following types were moved: `QueueTimeMetrics` and `VersionInfo`.
The following types were moved: `CompactOptions`, `EngineInfo`,
`EngineStatsInfo`, `LicenseInfo`, `QueueTimeMetrics`, `ServerAvailability`,
`ServerStatusInformation`, `SingleServerSupportInfo`, `ClusterSupportInfo`
and `VersionInfo`.

- Moved configuration related types to new `arangojs/config` module

Expand All @@ -294,8 +267,11 @@ for upgrading your code to arangojs v10.
- `GeoIndex` -> `GeoIndexDescription`
- `PersistentIndex` -> `PersistentIndexDescription`
- `PrimaryIndex` -> `PrimaryIndexDescription`
- `EdgeIndex` -> `EdgeIndexDescription`
- `TtlIndex` -> `TtlIndexDescription`
- `FulltextIndex` -> `FulltextIndexDescription`
- `MdiIndex` -> `MdiIndexDescription`
- `MdiPrefixedIndex` -> `MdiPrefixedIndexDescription`
- `InvertedIndex` -> `InvertedIndexDescription`
- `InternalArangosearchIndex` -> `ArangosearchIndexDescription`
- `InternalIndex` -> `InternalIndexDescription`
Expand Down Expand Up @@ -328,6 +304,7 @@ for upgrading your code to arangojs v10.
or `VerbNounResult` naming pattern:

- `QueryTracking` -> `QueryTrackingInfo`
- `ServerStatusInformation` -> `ServerStatusInfo`
- `CollectionImportResult` -> `ImportDocumentsResult`
- `CollectionEdgesResult` -> `DocumentEdgesResult`

Expand Down Expand Up @@ -403,6 +380,11 @@ for upgrading your code to arangojs v10.
This property provides a low-level interface for consuming the items of the
cursor and is used by the regular item-wise `Cursor` class internally.

- Added `SystemIndexDescription` type

This type represents either of the system index types `primary` and `edge`
and can be used to cast indexes returned by `collection.indexes`.

- Added `ProcessedResponse` type

This type replaces the previously internal `ArangojsResponse` type and
Expand Down Expand Up @@ -477,6 +459,37 @@ for upgrading your code to arangojs v10.
`cause` property. This error is only thrown when `db.waitForPropagation`
is invoked with a `timeout` option and the timeout duration is exceeded.

## [9.3.0] - 2025-01-06

### Added

- Added `db.compact` method (DE-906)

- Added `db.engineStats` method (DE-932)

- Added `db.getLicense` and `db.setLicense` methods (DE-949)

- Added `db.listQueryCacheEntries` method (DE-149)

- Added `db.clearQueryCache` method (DE-148)

- Added `db.getQueryCacheProperties` method (DE-150)

- Added `db.setQueryCacheProperties` method (DE-151)

- Added `collection.shards` method (DE-939)

- Added support for `mdi-prefixed` indexes (DE-956)

- Restored `fulltext` index type support (DE-957)

The `fulltext` index type is still no longer supported for creating new
indexes but can be used to cast existing indexes from `Index`.

- Added support for `edge` indexes (DE-958)

The `Index` type now can also be cast to the `EdgeIndex` type.

## [9.2.0] - 2024-11-27

### Added
Expand Down Expand Up @@ -2427,8 +2440,8 @@ For a detailed list of changes between pre-release versions of v7 see the

Graph methods now only return the relevant part of the response body.

[10.0.0-rc.0]: https://github.com/arangodb/arangojs/compare/v9.3.0...HEAD
[9.3.0]: https://github.com/arangodb/arangojs/compare/v9.2.0...v9.3.0
[10.0.0-rc.0]: https://github.com/arangodb/arangojs/compare/v9.2.0...v10.0.0-rc.0
[9.2.0]: https://github.com/arangodb/arangojs/compare/v9.1.0...v9.2.0
[9.1.0]: https://github.com/arangodb/arangojs/compare/v9.0.0...v9.1.0
[9.0.0]: https://github.com/arangodb/arangojs/compare/v8.8.1...v9.0.0
Expand Down
2 changes: 1 addition & 1 deletion src/administration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ export type LicenseInfo = {
/**
* Information about the server status.
*/
export type ServerStatusInformation = {
export type ServerStatusInfo = {
/**
* (Cluster Coordinators and DB-Servers only.) The address of the server.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/databases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ export class Database {
* // serverInfo: detailed information about the server
* ```
*/
status(): Promise<administration.ServerStatusInformation> {
status(): Promise<administration.ServerStatusInfo> {
return this.request({
method: "GET",
pathname: "/_admin/status",
Expand Down

0 comments on commit b6c2aac

Please sign in to comment.