-
Notifications
You must be signed in to change notification settings - Fork 138
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1748 from reebhub/RDoc-2568_indexHistoryInExport
Update Smuggler import/Export data for versions 5.4 and 6.0 (C# only)
- Loading branch information
Showing
12 changed files
with
1,084 additions
and
0 deletions.
There are no files selected for viewing
108 changes: 108 additions & 0 deletions
108
.../Raven.Documentation.Pages/client-api/smuggler/what-is-smuggler.dotnet.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| # What is Smuggler | ||
|
|
||
| Smuggler gives you the ability to export or import data from or to a database using JSON format. | ||
| It is exposed via the `DocumentStore.Smuggler` property. | ||
|
|
||
| {PANEL:ForDatabase} | ||
|
|
||
| By default, the `DocumentStore.Smuggler` works on the default document store database from the `DocumentStore.Database` property. | ||
|
|
||
| In order to switch it to a different database use the `.ForDatabase` method. | ||
|
|
||
| {CODE for_database@ClientApi\Smuggler\WhatIsSmuggler.cs /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:Export} | ||
|
|
||
| ### Syntax | ||
|
|
||
| {CODE export_syntax@ClientApi\Smuggler\WhatIsSmuggler.cs /} | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../client-api/smuggler/what-is-smuggler#databasesmugglerexportoptions). | | ||
| | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | ||
| | **toFile** | `string` | Path to a file where exported data will be written | | ||
| | **token** | `CancellationToken` | Token used to cancel the operation | | ||
|
|
||
| | Return Value | | | ||
| | ------------- | ----- | | ||
| | `Operation` | Instance of Operation class which gives you an ability to wait for the operation to complete and subscribe to operation progress events | | ||
|
|
||
| ### DatabaseSmugglerExportOptions | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **Collections** | `List<string>` | List of specific collections to export. If empty, then all collections will be exported. <br> Default: `empty` | | ||
| | **OperateOnTypes** | `DatabaseItemType` | Indicates what should be exported. <br> Default: `Indexes`, `Documents`, `RevisionDocuments`, `Conflicts`, `DatabaseRecord`, `ReplicationHubCertificates`, `Identities`, `CompareExchange`, `Attachments`, `CounterGroups`, `Subscriptions`, `TimeSeries` | | ||
| | **OperateOnDatabaseRecordTypes** | `DatabaseRecordItemType` | Indicates what should be exported from database record. <br> Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `Settings`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications`, `TimeSeries`, `DocumentsCompression`, `Analyzers`, `LockMode`, `OlapConnectionStrings`, `OlapEtls`, `ElasticSearchConnectionStrings`, `ElasticSearchEtls`, `PostgreSQLIntegration`, `QueueConnectionStrings`, `QueueEtls`, `IndexesHistory`, `Refresh` | | ||
| | **IncludeExpired** | `bool` | Should expired documents be imported. <br> Default: `true` | | ||
| | **IncludeArtificial** | `bool` | Should artificial documents be imported. <br> Default: `false` | | ||
| | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes. <br> Default: `false` | | ||
| | **TransformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../client-api/smuggler/what-is-smuggler#transformscript). | | ||
| | **MaxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. <br> Default: **10000** | | ||
|
|
||
| ### Example | ||
|
|
||
| {CODE export_example@ClientApi\Smuggler\WhatIsSmuggler.cs /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:Import} | ||
|
|
||
| ### Syntax | ||
|
|
||
| {CODE import_syntax@ClientApi\Smuggler\WhatIsSmuggler.cs /} | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../client-api/smuggler/what-is-smuggler#databasesmugglerimportoptions). | | ||
| | **stream** | `Stream` | Stream with data to import | | ||
| | **fromFile** | `string` | Path to a file from which data will be imported | | ||
| | **token** | `CancellationToken` | Token used to cancel the operation | | ||
|
|
||
| | Return Value | | | ||
| | ------------- | ----- | | ||
| | `Operation` | Instance of Operation-class which gives you an ability to wait for the operation to complete and subscribe to operation progress events | | ||
|
|
||
| ### DatabaseSmugglerImportOptions | ||
|
|
||
| | Parameters | | | | ||
| | - | - | - | | ||
| | **Collections** | `List<string>` | List specific of collections to import. If empty then all collections will be imported. <br> Default: `empty` | | ||
| | **OperateOnTypes** | `DatabaseItemType` | Indicates what should be exported. <br> Default: `Indexes`, `Documents`, `RevisionDocuments`, `Conflicts`, `DatabaseRecord`, `ReplicationHubCertificates`, `Identities`, `CompareExchange`, `Attachments`, `CounterGroups`, `Subscriptions`, `TimeSeries` | | ||
| | **OperateOnDatabaseRecordTypes** | `DatabaseRecordItemType` | Indicates what should be exported from database record. <br> Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `Settings`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications`, `TimeSeries`, `DocumentsCompression`, `Analyzers`, `LockMode`, `OlapConnectionStrings`, `OlapEtls`, `ElasticSearchConnectionStrings`, `ElasticSearchEtls`, `PostgreSQLIntegration`, `QueueConnectionStrings`, `QueueEtls`, `IndexesHistory`, `Refresh` | | ||
| | **IncludeExpired** | `bool` | Should expired documents be imported. <br> Default: `true` | | ||
| | **IncludeArtificial** | `bool` | Should artificial documents be imported. <br> Default: `false` | | ||
| | **RemoveAnalyzers** | `bool` | Should analyzers be removed from Indexes. <br> Default: `false` | | ||
| | **TransformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../client-api/smuggler/what-is-smuggler#transformscript). | | ||
| | **MaxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. <br> Default: **10000** | | ||
|
|
||
| ### Example | ||
|
|
||
| {CODE import_example@ClientApi\Smuggler\WhatIsSmuggler.cs /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:TransformScript} | ||
|
|
||
| `TransformScript` exposes the ability to modify or even filter-out the document during the import and export process using the provided JavaScript. | ||
|
|
||
| Underneath the JavaScript engine is exactly the same as used for [patching operations](../../client-api/operations/patching/single-document) giving you identical syntax and capabilities with additional **ability to filter out documents by throwing a 'skip' exception**. | ||
|
|
||
| {CODE-BLOCK:javascript} | ||
| var id = this['@metadata']['@id']; | ||
| if (id === 'orders/999-A') | ||
| throw 'skip'; // filter-out | ||
|
|
||
| this.Freight = 15.3; | ||
| {CODE-BLOCK/} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related articles | ||
|
|
||
| ### Studio | ||
|
|
||
| - [Backup Task](../../studio/database/tasks/backup-task) |
105 changes: 105 additions & 0 deletions
105
....4/Raven.Documentation.Pages/client-api/smuggler/what-is-smuggler.java.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # What is Smuggler | ||
|
|
||
| Smuggler gives you the ability to export or import data from or to a database using JSON format. | ||
| It is exposed via the `DocumentStore.smuggler()`. | ||
|
|
||
| {PANEL:ForDatabase} | ||
|
|
||
| By default, the `IDocumentStore.smuggler` works on the default document store database from the `IDocumentStore.database` property. | ||
|
|
||
| In order to switch it to a different database use the `.forDatabase` method. | ||
|
|
||
| {CODE:java for_database@ClientApi\Smuggler\WhatIsSmuggler.java /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:Export} | ||
|
|
||
| ### Syntax | ||
|
|
||
| {CODE:java export_syntax@ClientApi\Smuggler\WhatIsSmuggler.java /} | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../client-api/smuggler/what-is-smuggler#databasesmugglerexportoptions). | | ||
| | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | ||
| | **toFile** | `String` | Path to a file where exported data will be written | | ||
|
|
||
| | Return Value | | | ||
| | ------------- | ----- | | ||
| | `Operation` | Instance of Operation class which gives you an ability to wait for the operation to complete and subscribe to operation progress events | | ||
|
|
||
| ### DatabaseSmugglerExportOptions | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **Collections** | `List<String>` | List of specific collections to export. If empty, then all collections will be exported. Default: `empty` | | ||
| | **operateOnTypes** | `DatabaseItemType` | Indicates what should be exported. Default: `Indexes`, `Documents`, `RevisionDocuments`, `Conflicts`, `DatabaseRecord`, `Identities`, `CompareExchange`, `Subscriptions` | | ||
| | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be exported from database record. Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications` | | ||
| | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | ||
| | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | | ||
| | **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../client-api/smuggler/what-is-smuggler#transformscript). | | ||
| | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | | ||
|
|
||
| ### Example | ||
|
|
||
| {CODE:java export_example@ClientApi\Smuggler\WhatIsSmuggler.java /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:Import} | ||
|
|
||
| ### Syntax | ||
|
|
||
| {CODE:java import_syntax@ClientApi\Smuggler\WhatIsSmuggler.java /} | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../client-api/smuggler/what-is-smuggler#databasesmugglerimportoptions). | | ||
| | **stream** | `InputStream` | Stream with data to import | | ||
| | **fromFile** | `String` | Path to a file from which data will be imported | | ||
|
|
||
| | Return Value | | | ||
| | ------------- | ----- | | ||
| | `Operation` | Instance of Operation-class which gives you an ability to wait for the operation to complete and subscribe to operation progress events | | ||
|
|
||
| ### DatabaseSmugglerImportOptions | ||
|
|
||
| | Parameters | | | | ||
| | - | - | - | | ||
| | **Collections** | `List<String>` | List of specific collections to import. If empty, then all collections will be exported. Default: `empty` | | ||
| | **operateOnTypes** | `DatabaseItemType` | Indicates what should be imported. Default: `INDEXES`, `DOCUMENTS`, `REVISION_DOCUMENTS`, `CONFLICTS`, `DATABASE_RECORD`, `IDENTITIES`, `COMPARE_EXCHANGE`, `SUBSCRIPTIONS` | | ||
| | **operateOnDatabaseRecordType** | `DatabaseRecordItemType` | Indicates what should be imported. Default: `CLIENT`, `CONFLICT_SOLVER_CONFIG`, `EXPIRATION`, `EXTERNAL_REPLICATIONS`, `PERIODIC_BACKUPS`, `RAVEN_CONNECTION_STRINGS`, `RAVEN_ETLS`, `REVISIONS`, `SQL_CONNECTION_STRINGS`, `SORTERS`, `SQL_ETLS`, `HUB_PULL_REPLICATIONS`, `SINK_PULL_REPLICATIONS` | | ||
| | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | ||
| | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | | ||
| | **transformScript** | `String` | JavaScript-based script applied to every exported document. Read more [here](../../client-api/smuggler/what-is-smuggler#transformscript). | | ||
| | **maxStepsForTransformScript** | `int` | Maximum number of steps that transform script can process before failing. Default: 10000 | | ||
|
|
||
|
|
||
| ### Example | ||
|
|
||
| {CODE:java import_example@ClientApi\Smuggler\WhatIsSmuggler.java /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:TransformScript} | ||
|
|
||
| `TransformScript` exposes the ability to modify or even filter-out the document during the import and export process using the provided JavaScript. | ||
|
|
||
| Underneath the JavaScript engine is exactly the same as used for [patching operations](../../client-api/operations/patching/single-document) giving you identical syntax and capabilities with additional **ability to filter out documents by throwing a 'skip' exception**. | ||
|
|
||
| {CODE-BLOCK:javascript} | ||
| var id = this['@metadata']['@id']; | ||
| if (id === 'orders/999-A') | ||
| throw 'skip'; // filter-out | ||
|
|
||
| this.Freight = 15.3; | ||
| {CODE-BLOCK/} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related articles | ||
|
|
||
| ### Studio | ||
|
|
||
| - [Backup Task](../../studio/database/tasks/backup-task) |
109 changes: 109 additions & 0 deletions
109
.../5.4/Raven.Documentation.Pages/client-api/smuggler/what-is-smuggler.js.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| # What is Smuggler | ||
|
|
||
| Smuggler gives you the ability to export or import data from or to a database using JSON format. | ||
| It is exposed via the `DocumentStore.smuggler`. | ||
|
|
||
| {PANEL:ForDatabase} | ||
|
|
||
| By default, the `DocumentStore.smuggler` works on the default document store database from the `DocumentStore.database` . | ||
|
|
||
| In order to switch it to a different database use the `.forDatabase` method. | ||
|
|
||
| {CODE:nodejs for_database@client-api\smuggler\WhatIsSmuggler.js /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:Export} | ||
|
|
||
| ### Usage | ||
|
|
||
| {CODE:nodejs export_syntax@client-api\smuggler\WhatIsSmuggler.js /} | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **options** | `DatabaseSmugglerExportOptions` | Options that will be used during the export. Read more [here](../../client-api/smuggler/what-is-smuggler#databasesmugglerexportoptions). | | ||
| | **toDatabase** | `DatabaseSmuggler` | `DatabaseSmuggler` instance used as a destination | | ||
| | **toFile** | `string` | Path to a file where exported data will be written | | ||
|
|
||
| | Return Value | | | ||
| | ------------- | ----- | | ||
| | `Operation` | Instance of Operation class which gives you an ability to wait for the operation to complete and subscribe to operation progress events | | ||
|
|
||
| ### DatabaseSmugglerExportOptions | ||
|
|
||
| | Parameters | | | | ||
| | - | - | - | | ||
| | **collections** | ` string[]` | List of specific collections to export. If empty, then all collections will be exported. Default: `empty` | | ||
| | **operateOnTypes** | `DatabaseItemType[]` | Indicates what should be exported. Default: `Indexes`, `Documents`, `RevisionDocuments`, `Conflicts`, `DatabaseRecord`, `Identities`, `CompareExchange`, `Subscriptions` | | ||
| | **operateOnDatabaseRecordTypes** | `DatabaseRecordItemType[]` | Indicates what should be exported from database record. Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications` | | ||
| | **includeExpired** | `boolean` | Should expired documents be included in the export. Default: `true` | | ||
| | **includeArtificial** | `boolean` | ? | | ||
| | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | | ||
| | **transformScript** | `string` | JavaScript-based script applied to every exported document. Read more [here](../../client-api/smuggler/what-is-smuggler#transformscript). | | ||
| | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | ||
| | **skipRevisionCreation** | `boolean` | skip revision creation | | ||
| | **encryptionKey** | `string` | Encryption key used for restore | | ||
|
|
||
| ### Example | ||
|
|
||
| {CODE:nodejs export_example@client-api\smuggler\WhatIsSmuggler.js /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:Import} | ||
|
|
||
| ### Usage | ||
|
|
||
| {CODE:nodejs import_syntax@client-api\smuggler\WhatIsSmuggler.js /} | ||
|
|
||
| | Parameters | | | | ||
| | ------------- | ------------- | ----- | | ||
| | **options** | `DatabaseSmugglerImportOptions` | Options that will be used during the import. Read more [here](../../client-api/smuggler/what-is-smuggler#databasesmugglerimportoptions). | | ||
| | **stream** | `Stream` | Stream with data to import | | ||
| | **fromFile** | `string` | Path to a file from which data will be imported | | ||
|
|
||
| | Return Value | | | ||
| | ------------- | ----- | | ||
| | `Operation` | Instance of Operation-class which gives you an ability to wait for the operation to complete and subscribe to operation progress events | | ||
|
|
||
| ### DatabaseSmugglerImportOptions | ||
|
|
||
| | Parameters | | | | ||
| | - | - | - | | ||
| | **operateOnTypes** | `DatabaseItemType[]` | Indicates what should be imported. Default: `Indexes`, `Documents`, `RevisionDocuments`, `Conflicts`, `DatabaseRecord`, `Identities`, `CompareExchange`, `Subscriptions` | | ||
| | **operateOnDatabaseRecordTypes** | `DatabaseRecordItemType[]` | Indicates what should be imported. Default: `Client`, `ConflictSolverConfig`, `Expiration`, `ExternalReplications`, `PeriodicBackups`, `RavenConnectionStrings`, `RavenEtls`, `Revisions`, `SqlConnectionStrings`, `Sorters`, `SqlEtls`, `HubPullReplications`, `SinkPullReplications` | | ||
| | **includeExpired** | `boolean` | Should expired documents be included in the import. Default: `true` | | ||
| | **includeArtificial** | `boolean` | ? | | ||
| | **removeAnalyzers** | `boolean` | Should analyzers be removed from Indexes. Default: `false` | | ||
| | **transformScript** | `string` | JavaScript-based script applied to every imported document. Read more [here](../../client-api/smuggler/what-is-smuggler#transformscript). | | ||
| | **maxStepsForTransformScript** | `number` | Maximum number of steps that transform script can process before failing. Default: 10000 | | ||
| | **skipRevisionCreation** | `boolean` | skip revision creation | | ||
| | **encryptionKey** | `string` | Encryption key used for restore | | ||
|
|
||
| ### Example | ||
|
|
||
| {CODE:nodejs import_example@client-api\smuggler\WhatIsSmuggler.js /} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| {PANEL:TransformScript} | ||
|
|
||
| `TransformScript` exposes the ability to modify or even filter-out the document during the import and export process using the provided JavaScript. | ||
|
|
||
| Underneath the JavaScript engine is exactly the same as used for [patching operations](../../client-api/operations/patching/single-document) giving you identical syntax and capabilities with additional **ability to filter out documents by throwing a 'skip' exception**. | ||
|
|
||
| {CODE-BLOCK:javascript} | ||
| var id = this['@metadata']['@id']; | ||
| if (id === 'orders/999-A') | ||
| throw 'skip'; // filter-out | ||
|
|
||
| this.Freight = 15.3; | ||
| {CODE-BLOCK/} | ||
|
|
||
| {PANEL/} | ||
|
|
||
| ## Related articles | ||
|
|
||
| ### Studio | ||
|
|
||
| - [Backup Task](../../studio/database/tasks/backup-task) |
Oops, something went wrong.