neon 3.0.0 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (207) hide show
  1. package/README.md +70 -5
  2. package/dist/_chunks/auth_selection-DGgq6ifc.js +83 -0
  3. package/dist/_chunks/cmd_pipeline-CUbBO9U_.js +2818 -0
  4. package/dist/_chunks/credentials-MYdHdKah.js +188 -0
  5. package/dist/_chunks/env-NbA61JR3.js +585 -0
  6. package/dist/_chunks/env_services-Tz9G4JeT.js +531 -0
  7. package/dist/_chunks/paths-DMq0Lt7a.js +151 -0
  8. package/dist/_chunks/profiles-Ir29rqns.js +217 -0
  9. package/dist/_chunks/psql-DWH-kc69.js +2169 -0
  10. package/dist/_chunks/rolldown-runtime-D7D4PA-g.js +13 -0
  11. package/dist/_chunks/secure_file-BucZj4yQ.js +39 -0
  12. package/dist/analytics.js +163 -207
  13. package/dist/api.js +815 -758
  14. package/dist/auth.js +121 -141
  15. package/dist/auth_context.js +39 -53
  16. package/dist/cli.js +4 -7
  17. package/dist/commands/api.js +220 -250
  18. package/dist/commands/api_keys.js +251 -314
  19. package/dist/commands/auth.js +283 -328
  20. package/dist/commands/bootstrap.js +372 -437
  21. package/dist/commands/branches.js +304 -455
  22. package/dist/commands/bucket.js +374 -514
  23. package/dist/commands/checkout.js +213 -298
  24. package/dist/commands/config.js +573 -690
  25. package/dist/commands/connection_string.js +137 -165
  26. package/dist/commands/data_api.js +238 -260
  27. package/dist/commands/databases.js +67 -76
  28. package/dist/commands/deploy.js +31 -25
  29. package/dist/commands/dev.js +639 -719
  30. package/dist/commands/diff.js +156 -200
  31. package/dist/commands/env.js +255 -305
  32. package/dist/commands/functions.js +275 -355
  33. package/dist/commands/index.js +70 -65
  34. package/dist/commands/init.js +84 -119
  35. package/dist/commands/inspect.js +55 -55
  36. package/dist/commands/ip_allow.js +88 -120
  37. package/dist/commands/link.js +874 -1019
  38. package/dist/commands/logs.js +291 -0
  39. package/dist/commands/neon_auth.js +725 -933
  40. package/dist/commands/operations.js +34 -25
  41. package/dist/commands/orgs.js +28 -18
  42. package/dist/commands/profile.js +615 -846
  43. package/dist/commands/projects.js +313 -373
  44. package/dist/commands/psql.js +60 -58
  45. package/dist/commands/roles.js +55 -58
  46. package/dist/commands/schema_diff.js +87 -131
  47. package/dist/commands/set_context.js +34 -26
  48. package/dist/commands/snapshots.js +288 -413
  49. package/dist/commands/status.js +41 -37
  50. package/dist/commands/user.js +21 -10
  51. package/dist/commands/vpc_endpoints.js +85 -113
  52. package/dist/config.js +7 -6
  53. package/dist/config_format.js +50 -66
  54. package/dist/config_template.js +128 -157
  55. package/dist/context.js +183 -235
  56. package/dist/current_branch_fast_path.js +40 -49
  57. package/dist/dev/env.js +2 -446
  58. package/dist/dev/functions.js +54 -68
  59. package/dist/dev/inputs.js +46 -58
  60. package/dist/dev/runtime.js +135 -164
  61. package/dist/dev/websocket.js +766 -959
  62. package/dist/env.js +27 -33
  63. package/dist/env_file.js +118 -132
  64. package/dist/env_services.js +2 -51
  65. package/dist/errors.js +57 -68
  66. package/dist/functions_api.js +45 -43
  67. package/dist/help.js +189 -140
  68. package/dist/index.js +182 -257
  69. package/dist/init/agents.js +137 -118
  70. package/dist/init/auth.js +58 -68
  71. package/dist/init/bootstrap.js +325 -396
  72. package/dist/init/build_config.js +4 -2
  73. package/dist/init/detect_agent.js +56 -101
  74. package/dist/init/editors.js +35 -52
  75. package/dist/init/enrich_output.js +51 -66
  76. package/dist/init/extension.js +134 -171
  77. package/dist/init/inspect.js +179 -266
  78. package/dist/init/interactive.js +510 -622
  79. package/dist/init/neonctl.js +117 -168
  80. package/dist/init/orchestrate.js +157 -173
  81. package/dist/init/phases/auth.js +188 -202
  82. package/dist/init/phases/cleanup.js +23 -23
  83. package/dist/init/phases/db.js +251 -277
  84. package/dist/init/phases/getting_started.js +213 -223
  85. package/dist/init/phases/mcp.js +174 -224
  86. package/dist/init/phases/migrations.js +247 -248
  87. package/dist/init/phases/neon_auth.js +114 -133
  88. package/dist/init/phases/setup.js +546 -703
  89. package/dist/init/phases/skills.js +75 -86
  90. package/dist/init/phases/status.js +72 -67
  91. package/dist/init/resolve_context.js +102 -99
  92. package/dist/init/route_command.js +91 -98
  93. package/dist/init/skills.js +174 -218
  94. package/dist/init/vsix.js +77 -99
  95. package/dist/log.js +17 -16
  96. package/dist/neon_services.js +104 -129
  97. package/dist/parameters.gen.js +481 -471
  98. package/dist/pkg.js +17 -19
  99. package/dist/profile_keys.js +44 -47
  100. package/dist/psql/cli.js +44 -47
  101. package/dist/psql/command/cmd_cond.js +231 -406
  102. package/dist/psql/command/cmd_connect.js +557 -764
  103. package/dist/psql/command/cmd_copy.js +728 -984
  104. package/dist/psql/command/cmd_describe.js +1499 -1688
  105. package/dist/psql/command/cmd_format.js +733 -905
  106. package/dist/psql/command/cmd_io.js +2 -2193
  107. package/dist/psql/command/cmd_lo.js +297 -359
  108. package/dist/psql/command/cmd_meta.js +727 -878
  109. package/dist/psql/command/cmd_misc.js +138 -172
  110. package/dist/psql/command/cmd_pipeline.js +2 -1148
  111. package/dist/psql/command/cmd_restrict.js +119 -155
  112. package/dist/psql/command/cmd_show.js +529 -688
  113. package/dist/psql/command/dispatch.js +260 -325
  114. package/dist/psql/command/inputQueue.js +35 -33
  115. package/dist/psql/command/shared.js +49 -63
  116. package/dist/psql/complete/filenames.js +90 -133
  117. package/dist/psql/complete/index.js +59 -97
  118. package/dist/psql/complete/matcher.js +236 -300
  119. package/dist/psql/complete/psqlVars.js +218 -223
  120. package/dist/psql/complete/queries.js +159 -177
  121. package/dist/psql/complete/rules.js +1493 -2299
  122. package/dist/psql/core/common.js +2 -1253
  123. package/dist/psql/core/help.js +456 -546
  124. package/dist/psql/core/mainloop.js +692 -1303
  125. package/dist/psql/core/prompt.js +391 -408
  126. package/dist/psql/core/settings.js +429 -644
  127. package/dist/psql/core/sqlHelp.js +480 -554
  128. package/dist/psql/core/startup.js +2 -846
  129. package/dist/psql/core/syncVars.js +67 -110
  130. package/dist/psql/core/variables.js +156 -278
  131. package/dist/psql/describe/formatters.js +884 -1285
  132. package/dist/psql/describe/processNamePattern.js +173 -260
  133. package/dist/psql/describe/queries.js +1368 -2403
  134. package/dist/psql/describe/versionGate.js +32 -41
  135. package/dist/psql/index.js +2 -2030
  136. package/dist/psql/io/history.js +232 -271
  137. package/dist/psql/io/input.js +103 -108
  138. package/dist/psql/io/lineEditor/buffer.js +238 -319
  139. package/dist/psql/io/lineEditor/complete.js +135 -213
  140. package/dist/psql/io/lineEditor/filename.js +139 -148
  141. package/dist/psql/io/lineEditor/index.js +653 -870
  142. package/dist/psql/io/lineEditor/keymap.js +544 -702
  143. package/dist/psql/io/lineEditor/vt100.js +294 -341
  144. package/dist/psql/io/pgpass.js +158 -187
  145. package/dist/psql/io/pgservice.js +146 -183
  146. package/dist/psql/io/psqlrc.js +328 -403
  147. package/dist/psql/print/aligned.js +1020 -1683
  148. package/dist/psql/print/asciidoc.js +180 -214
  149. package/dist/psql/print/crosstab.js +281 -442
  150. package/dist/psql/print/csv.js +48 -70
  151. package/dist/psql/print/html.js +195 -226
  152. package/dist/psql/print/json.js +75 -88
  153. package/dist/psql/print/latex.js +291 -364
  154. package/dist/psql/print/pager.js +171 -242
  155. package/dist/psql/print/troff.js +194 -226
  156. package/dist/psql/print/unaligned.js +69 -95
  157. package/dist/psql/print/units.js +167 -169
  158. package/dist/psql/scanner/slash.js +428 -483
  159. package/dist/psql/scanner/sql.js +445 -889
  160. package/dist/psql/scanner/stringutils.js +309 -379
  161. package/dist/psql/types/index.js +8 -7
  162. package/dist/psql/types/scanner.js +25 -22
  163. package/dist/psql/wire/connection.js +2042 -2803
  164. package/dist/psql/wire/copy.js +84 -100
  165. package/dist/psql/wire/notify.js +39 -59
  166. package/dist/psql/wire/pipeline.js +305 -518
  167. package/dist/psql/wire/protocol.js +349 -417
  168. package/dist/psql/wire/sasl.js +180 -265
  169. package/dist/psql/wire/tls.js +400 -561
  170. package/dist/storage_api.js +115 -129
  171. package/dist/test_utils/fixtures.js +94 -113
  172. package/dist/test_utils/oauth_server.js +10 -7
  173. package/dist/test_utils/project_dir.js +33 -0
  174. package/dist/utils/ai_gateway_notice.js +131 -162
  175. package/dist/utils/api_enums.js +21 -28
  176. package/dist/utils/auth.js +10 -4
  177. package/dist/utils/branch_notice.js +20 -19
  178. package/dist/utils/branch_picker.js +83 -89
  179. package/dist/utils/cli_name.js +15 -12
  180. package/dist/utils/compute_units.js +20 -27
  181. package/dist/utils/config_diff.js +127 -158
  182. package/dist/utils/enrichers.js +95 -148
  183. package/dist/utils/esbuild.js +130 -189
  184. package/dist/utils/flags.js +35 -47
  185. package/dist/utils/formats.js +8 -15
  186. package/dist/utils/git_diff.js +69 -80
  187. package/dist/utils/inspect_db.js +101 -143
  188. package/dist/utils/inspect_queries.js +179 -142
  189. package/dist/utils/middlewares.js +39 -45
  190. package/dist/utils/openapi.js +87 -99
  191. package/dist/utils/package_manager.js +312 -110
  192. package/dist/utils/point_in_time.js +49 -53
  193. package/dist/utils/psql.js +89 -106
  194. package/dist/utils/service_picker.js +55 -58
  195. package/dist/utils/string.js +5 -5
  196. package/dist/utils/ui.js +38 -55
  197. package/dist/utils/write_sync.js +26 -35
  198. package/dist/utils/zip.js +4 -3
  199. package/dist/writer.js +67 -87
  200. package/package.json +11 -6
  201. package/dist/_shared/auth_selection.js +0 -86
  202. package/dist/_shared/credentials.js +0 -209
  203. package/dist/_shared/env-core/env.js +0 -558
  204. package/dist/_shared/env-core/reuse-secrets.js +0 -223
  205. package/dist/_shared/paths.js +0 -148
  206. package/dist/_shared/profiles.js +0 -276
  207. package/dist/_shared/secure_file.js +0 -43
@@ -1,488 +1,337 @@
1
+ import { t as __exportAll } from "../_chunks/rolldown-runtime-D7D4PA-g.js";
2
+ import { log } from "../log.js";
1
3
  import { retryOnLock } from "../api.js";
2
4
  import { contextBranch, readContextFile } from "../context.js";
3
- import { log } from "../log.js";
5
+ import { writer } from "../writer.js";
4
6
  import { branchCreateRequest } from "../parameters.gen.js";
5
7
  import { EndpointType } from "../utils/api_enums.js";
6
8
  import { getComputeUnits } from "../utils/compute_units.js";
7
- import { branchIdFromProps, branchIdResolve, fillSingleProject, } from "../utils/enrichers.js";
8
- import { looksLikeBranchId, looksLikeLSN, looksLikeTimestamp, } from "../utils/formats.js";
9
+ import { looksLikeBranchId, looksLikeLSN, looksLikeTimestamp } from "../utils/formats.js";
10
+ import { branchIdFromProps, branchIdResolve, fillSingleProject } from "../utils/enrichers.js";
9
11
  import { parsePointInTime } from "../utils/point_in_time.js";
10
12
  import { psql } from "../utils/psql.js";
11
- import { writer } from "../writer.js";
12
13
  import { parseSchemaDiffParams, schemaDiff } from "./schema_diff.js";
13
- export const BRANCH_FIELDS = [
14
- "name",
15
- "id",
16
- "current_state",
17
- "created_at",
18
- "expires_at",
14
+ //#region src/commands/branches.ts
15
+ var branches_exports = /* @__PURE__ */ __exportAll({
16
+ BRANCH_FIELDS: () => BRANCH_FIELDS,
17
+ aliases: () => aliases,
18
+ builder: () => builder,
19
+ command: () => command,
20
+ describe: () => describe,
21
+ handler: () => handler
22
+ });
23
+ const BRANCH_FIELDS = [
24
+ "name",
25
+ "id",
26
+ "current_state",
27
+ "created_at",
28
+ "expires_at"
19
29
  ];
20
30
  const BRANCH_FIELDS_RESET = [
21
- "name",
22
- "id",
23
- "default",
24
- "current_state",
25
- "created_at",
26
- "last_reset_at",
31
+ "name",
32
+ "id",
33
+ "default",
34
+ "current_state",
35
+ "created_at",
36
+ "last_reset_at"
27
37
  ];
28
- export const command = "branches";
29
- export const describe = "Manage branches";
30
- export const aliases = ["branch"];
31
- export const builder = (argv) => argv
32
- .usage("$0 branches <sub-command> [options]")
33
- .options({
34
- "project-id": {
35
- describe: "Project ID",
36
- type: "string",
37
- },
38
- })
39
- .middleware(fillSingleProject)
40
- .middleware((args) => {
41
- // Provide alias for analytics
42
- args.branchId ?? (args.branchId = args.id);
43
- })
44
- .command("list", "List branches", (yargs) => yargs, (args) => list(args))
45
- .command("create", "Create a branch", (yargs) => yargs.options({
46
- name: branchCreateRequest["branch.name"],
47
- parent: {
48
- describe: "Parent branch name or id or timestamp or LSN. Defaults to the default branch",
49
- type: "string",
50
- },
51
- compute: {
52
- describe: "Create a branch with or without a compute. By default branch is created with a read-write compute. To create a branch without compute use --no-compute",
53
- type: "boolean",
54
- default: true,
55
- },
56
- type: {
57
- describe: "Type of compute to add",
58
- type: "string",
59
- implies: "compute",
60
- default: EndpointType.ReadWrite,
61
- choices: Object.values(EndpointType),
62
- },
63
- "suspend-timeout": {
64
- describe: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe maximum value is `604800` seconds (1 week).",
65
- type: "number",
66
- implies: "compute",
67
- default: 0,
68
- },
69
- cu: {
70
- describe: 'The number of Compute Units. Could be a fixed size (e.g. "2") or a range delimited by a dash (e.g. "0.5-3").',
71
- type: "string",
72
- implies: "compute",
73
- },
74
- psql: {
75
- type: "boolean",
76
- describe: "Connect to a new branch via psql",
77
- default: false,
78
- },
79
- fallback: {
80
- type: "boolean",
81
- describe: "Force the embedded TypeScript psql fallback (for testing)",
82
- default: false,
83
- hidden: true,
84
- },
85
- annotation: {
86
- type: "string",
87
- hidden: true,
88
- default: "{}",
89
- },
90
- "schema-only": {
91
- describe: "Create a schema-only branch. Requires exactly one read-write compute.",
92
- type: "boolean",
93
- default: false,
94
- },
95
- "expires-at": {
96
- describe: "Set an expiration date for the branch. Accepts a date string (e.g., 2024-12-31T23:59:59Z).",
97
- type: "string",
98
- requiresArg: true,
99
- },
100
- protected: {
101
- describe: branchCreateRequest["branch.protected"].description,
102
- type: "boolean",
103
- },
104
- }), (args) => create(args))
105
- .command("reset <id|name>", "Reset a branch", (yargs) => yargs.options({
106
- parent: {
107
- describe: "Reset to a parent branch",
108
- type: "boolean",
109
- default: false,
110
- },
111
- "preserve-under-name": {
112
- describe: "Name under which to preserve the old branch",
113
- },
114
- }), (args) => reset(args))
115
- .command("restore <target-id|name> <source>[@(timestamp|lsn)]", "Restores a branch to a specific point in time\n<source> can be: ^self, ^parent, or <source-branch-id|name>", (yargs) => yargs
116
- // we want to show meaningful help for the command
117
- // but it makes yargs to fail on parsing the command
118
- // so we need to fill in the missing args manually
119
- .middleware((args) => {
120
- args.id = args.targetId;
121
- args.pointInTime = args["source@(timestamp"];
122
- args.branchId = args.id; // for analytics
123
- })
124
- .usage("$0 branches restore <target-id|name> <source>[@(timestamp|lsn)]")
125
- .options({
126
- "preserve-under-name": {
127
- describe: "Name under which to preserve the old branch",
128
- },
129
- })
130
- .example([
131
- [
132
- "$0 branches restore main br-source-branch-123456",
133
- "Restores main to the head of the branch with id br-source-branch-123456",
134
- ],
135
- [
136
- "$0 branches restore main source@2021-01-01T00:00:00Z",
137
- "Restores main to the timestamp 2021-01-01T00:00:00Z of the source branch",
138
- ],
139
- [
140
- "$0 branches restore my-branch ^self@0/123456",
141
- "Restores my-branch to the LSN 0/123456 from its own history",
142
- ],
143
- [
144
- "$0 branches restore my-branch ^parent",
145
- "Restore my-branch to the head of its parent branch",
146
- ],
147
- ]), (args) => restore(args))
148
- .command("rename <id|name> <new-name>", "Rename a branch", (yargs) => yargs, (args) => rename(args))
149
- .command("set-default <id|name>", "Set a branch as default", (yargs) => yargs, (args) => setDefault(args))
150
- .command({
151
- command: "set-expiration <id|name>",
152
- describe: "Set an expiration date for the branch",
153
- builder: (yargs) => yargs.options({
154
- "expires-at": {
155
- describe: "Set a expiration date for the branch. If omitted, expiration will be removed. Format [RFC3339]: 2024-12-31T23:59:59Z",
156
- type: "string",
157
- requiresArg: false,
158
- },
159
- }),
160
- handler: (args) => setExpiration(args),
161
- })
162
- .command("add-compute <id|name>", "Add a compute to a branch", (yargs) => yargs.options({
163
- type: {
164
- type: "string",
165
- choices: Object.values(EndpointType),
166
- describe: "Type of compute to add",
167
- default: EndpointType.ReadOnly,
168
- },
169
- cu: {
170
- describe: 'The number of Compute Units. Could be a fixed size (e.g. "2") or a range delimited by a dash (e.g. "0.5-3").',
171
- type: "string",
172
- },
173
- name: {
174
- type: "string",
175
- describe: "Optional name of the compute",
176
- },
177
- }), (args) => addCompute(args))
178
- .command("delete <id|name>", "Delete a branch", (yargs) => yargs, (args) => deleteBranch(args))
179
- .command("get <id|name>", "Get a branch", (yargs) => yargs, (args) => get(args))
180
- .command({
181
- command: "schema-diff [base-branch] [compare-source[@(timestamp|lsn)]]",
182
- aliases: ["sd"],
183
- describe: "Compare the latest schemas of any two branches, or compare a branch to its own or another branch's history.",
184
- builder: (yargs) => {
185
- return yargs
186
- .middleware((args) => (args.compareSource =
187
- args["compare-source@(timestamp"]))
188
- .middleware(parseSchemaDiffParams)
189
- .options({
190
- database: {
191
- alias: "db",
192
- type: "string",
193
- description: "Name of the database for which the schema comparison is performed",
194
- },
195
- })
196
- .example([
197
- [
198
- "$0 branches schema-diff main br-compare-branch-123456",
199
- "Compares the main branch to the head of the branch with ID br-compare-branch-123456",
200
- ],
201
- [
202
- "$0 branches schema-diff main compare@2024-06-01T00:00:00Z",
203
- "Compares the main branch to the state of the compare branch at timestamp 2024-06-01T00:00:00.000Z",
204
- ],
205
- [
206
- "$0 branches schema-diff my-branch ^self@0/123456",
207
- "Compares my-branch to LSN 0/123456 from its own history",
208
- ],
209
- [
210
- "$0 branches schema-diff my-branch ^parent",
211
- "Compares my-branch to the head of its parent branch",
212
- ],
213
- [
214
- "$0 branches schema-diff",
215
- "If a branch is specified in 'set-context', compares this branch to its parent. Otherwise, compares the default branch to its parent.",
216
- ],
217
- ]);
218
- },
219
- handler: (args) => schemaDiff(args),
38
+ const command = "branches";
39
+ const describe = "Manage branches";
40
+ const aliases = ["branch"];
41
+ const builder = (argv) => argv.usage("$0 branches <sub-command> [options]").options({ "project-id": {
42
+ describe: "Project ID",
43
+ type: "string"
44
+ } }).middleware(fillSingleProject).middleware((args) => {
45
+ args.branchId ??= args.id;
46
+ }).command("list", "List branches", (yargs) => yargs, (args) => list(args)).command("create", "Create a branch", (yargs) => yargs.options({
47
+ name: branchCreateRequest["branch.name"],
48
+ parent: {
49
+ describe: "Parent branch name or id or timestamp or LSN. Defaults to the default branch",
50
+ type: "string"
51
+ },
52
+ compute: {
53
+ describe: "Create a branch with or without a compute. By default branch is created with a read-write compute. To create a branch without compute use --no-compute",
54
+ type: "boolean",
55
+ default: true
56
+ },
57
+ type: {
58
+ describe: "Type of compute to add",
59
+ type: "string",
60
+ implies: "compute",
61
+ default: EndpointType.ReadWrite,
62
+ choices: Object.values(EndpointType)
63
+ },
64
+ "suspend-timeout": {
65
+ describe: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe maximum value is `604800` seconds (1 week).",
66
+ type: "number",
67
+ implies: "compute",
68
+ default: 0
69
+ },
70
+ cu: {
71
+ describe: "The number of Compute Units. Could be a fixed size (e.g. \"2\") or a range delimited by a dash (e.g. \"0.5-3\").",
72
+ type: "string",
73
+ implies: "compute"
74
+ },
75
+ psql: {
76
+ type: "boolean",
77
+ describe: "Connect to a new branch via psql",
78
+ default: false
79
+ },
80
+ fallback: {
81
+ type: "boolean",
82
+ describe: "Force the embedded TypeScript psql fallback (for testing)",
83
+ default: false,
84
+ hidden: true
85
+ },
86
+ annotation: {
87
+ type: "string",
88
+ hidden: true,
89
+ default: "{}"
90
+ },
91
+ "schema-only": {
92
+ describe: "Create a schema-only branch. Requires exactly one read-write compute.",
93
+ type: "boolean",
94
+ default: false
95
+ },
96
+ "expires-at": {
97
+ describe: "Set an expiration date for the branch. Accepts a date string (e.g., 2024-12-31T23:59:59Z).",
98
+ type: "string",
99
+ requiresArg: true
100
+ },
101
+ protected: {
102
+ describe: branchCreateRequest["branch.protected"].description,
103
+ type: "boolean"
104
+ }
105
+ }), (args) => create(args)).command("reset <id|name>", "Reset a branch", (yargs) => yargs.options({
106
+ parent: {
107
+ describe: "Reset to a parent branch",
108
+ type: "boolean",
109
+ default: false
110
+ },
111
+ "preserve-under-name": { describe: "Name under which to preserve the old branch" }
112
+ }), (args) => reset(args)).command("restore <target-id|name> <source>[@(timestamp|lsn)]", "Restores a branch to a specific point in time\n<source> can be: ^self, ^parent, or <source-branch-id|name>", (yargs) => yargs.middleware((args) => {
113
+ args.id = args.targetId;
114
+ args.pointInTime = args["source@(timestamp"];
115
+ args.branchId = args.id;
116
+ }).usage("$0 branches restore <target-id|name> <source>[@(timestamp|lsn)]").options({ "preserve-under-name": { describe: "Name under which to preserve the old branch" } }).example([
117
+ ["$0 branches restore main br-source-branch-123456", "Restores main to the head of the branch with id br-source-branch-123456"],
118
+ ["$0 branches restore main source@2021-01-01T00:00:00Z", "Restores main to the timestamp 2021-01-01T00:00:00Z of the source branch"],
119
+ ["$0 branches restore my-branch ^self@0/123456", "Restores my-branch to the LSN 0/123456 from its own history"],
120
+ ["$0 branches restore my-branch ^parent", "Restore my-branch to the head of its parent branch"]
121
+ ]), (args) => restore(args)).command("rename <id|name> <new-name>", "Rename a branch", (yargs) => yargs, (args) => rename(args)).command("set-default <id|name>", "Set a branch as default", (yargs) => yargs, (args) => setDefault(args)).command({
122
+ command: "set-expiration <id|name>",
123
+ describe: "Set an expiration date for the branch",
124
+ builder: (yargs) => yargs.options({ "expires-at": {
125
+ describe: "Set a expiration date for the branch. If omitted, expiration will be removed. Format [RFC3339]: 2024-12-31T23:59:59Z",
126
+ type: "string",
127
+ requiresArg: false
128
+ } }),
129
+ handler: (args) => setExpiration(args)
130
+ }).command("add-compute <id|name>", "Add a compute to a branch", (yargs) => yargs.options({
131
+ type: {
132
+ type: "string",
133
+ choices: Object.values(EndpointType),
134
+ describe: "Type of compute to add",
135
+ default: EndpointType.ReadOnly
136
+ },
137
+ cu: {
138
+ describe: "The number of Compute Units. Could be a fixed size (e.g. \"2\") or a range delimited by a dash (e.g. \"0.5-3\").",
139
+ type: "string"
140
+ },
141
+ name: {
142
+ type: "string",
143
+ describe: "Optional name of the compute"
144
+ }
145
+ }), (args) => addCompute(args)).command("delete <id|name>", "Delete a branch", (yargs) => yargs, (args) => deleteBranch(args)).command("get <id|name>", "Get a branch", (yargs) => yargs, (args) => get(args)).command({
146
+ command: "schema-diff [base-branch] [compare-source[@(timestamp|lsn)]]",
147
+ aliases: ["sd"],
148
+ describe: "Compare the latest schemas of any two branches, or compare a branch to its own or another branch's history.",
149
+ builder: (yargs) => {
150
+ return yargs.middleware((args) => args.compareSource = args["compare-source@(timestamp"]).middleware(parseSchemaDiffParams).options({ database: {
151
+ alias: "db",
152
+ type: "string",
153
+ description: "Name of the database for which the schema comparison is performed"
154
+ } }).example([
155
+ ["$0 branches schema-diff main br-compare-branch-123456", "Compares the main branch to the head of the branch with ID br-compare-branch-123456"],
156
+ ["$0 branches schema-diff main compare@2024-06-01T00:00:00Z", "Compares the main branch to the state of the compare branch at timestamp 2024-06-01T00:00:00.000Z"],
157
+ ["$0 branches schema-diff my-branch ^self@0/123456", "Compares my-branch to LSN 0/123456 from its own history"],
158
+ ["$0 branches schema-diff my-branch ^parent", "Compares my-branch to the head of its parent branch"],
159
+ ["$0 branches schema-diff", "If a branch is specified in 'set-context', compares this branch to its parent. Otherwise, compares the default branch to its parent."]
160
+ ]);
161
+ },
162
+ handler: (args) => schemaDiff(args)
220
163
  });
221
- export const handler = (args) => {
222
- return args;
164
+ const handler = (args) => {
165
+ return args;
223
166
  };
224
167
  const list = async (props) => {
225
- const { data: { branches, annotations }, } = await props.apiClient.listProjectBranches({
226
- projectId: props.projectId,
227
- });
228
- // The branch pinned in the local context (.neon), so we can flag it as `[current]` — the
229
- // one commands target by default and that `neonctl env pull` would read. The context
230
- // stores the branch by name (preferred) or id, so match against either.
231
- const currentBranch = contextBranch(readContextFile(props.contextFile));
232
- writer(props).end(branches, {
233
- fields: BRANCH_FIELDS,
234
- renderColumns: {
235
- expires_at: (br) => br.expires_at || "never",
236
- // Word labels (not symbols) so they read clearly and match the existing `[anon]`.
237
- name: (br) => {
238
- const annotation = annotations[br.id];
239
- const isAnon = annotation?.value.anonymized;
240
- const labels = [];
241
- if (br.default) {
242
- labels.push("[default]");
243
- }
244
- if (br.protected) {
245
- labels.push("[protected]");
246
- }
247
- if (isAnon) {
248
- labels.push("[anon]");
249
- }
250
- if (currentBranch !== undefined &&
251
- (br.id === currentBranch || br.name === currentBranch)) {
252
- labels.push("[current]");
253
- }
254
- labels.push(br.name);
255
- return labels.join(" ");
256
- },
257
- },
258
- });
168
+ const { data: { branches, annotations } } = await props.apiClient.listProjectBranches({ projectId: props.projectId });
169
+ const currentBranch = contextBranch(readContextFile(props.contextFile));
170
+ writer(props).end(branches, {
171
+ fields: BRANCH_FIELDS,
172
+ renderColumns: {
173
+ expires_at: (br) => br.expires_at || "never",
174
+ name: (br) => {
175
+ const isAnon = annotations[br.id]?.value.anonymized;
176
+ const labels = [];
177
+ if (br.default) labels.push("[default]");
178
+ if (br.protected) labels.push("[protected]");
179
+ if (isAnon) labels.push("[anon]");
180
+ if (currentBranch !== void 0 && (br.id === currentBranch || br.name === currentBranch)) labels.push("[current]");
181
+ labels.push(br.name);
182
+ return labels.join(" ");
183
+ }
184
+ }
185
+ });
259
186
  };
260
187
  const create = async (props) => {
261
- const branches = await props.apiClient
262
- .listProjectBranches({ projectId: props.projectId })
263
- .then(({ data }) => data.branches);
264
- const parentProps = (() => {
265
- if (!props.parent) {
266
- const branch = branches.find((b) => b.default);
267
- if (!branch) {
268
- throw new Error("No default branch found");
269
- }
270
- return { parent_id: branch.id };
271
- }
272
- if (looksLikeLSN(props.parent)) {
273
- return { parent_lsn: props.parent };
274
- }
275
- if (looksLikeTimestamp(props.parent)) {
276
- return { parent_timestamp: props.parent };
277
- }
278
- if (looksLikeBranchId(props.parent)) {
279
- return { parent_id: props.parent };
280
- }
281
- const branch = branches.find((b) => b.name === props.parent);
282
- if (!branch) {
283
- throw new Error(`Branch ${props.parent} not found`);
284
- }
285
- return { parent_id: branch.id };
286
- })();
287
- // Validate schema-only branch requirements
288
- if (props.schemaOnly) {
289
- if (!props.compute) {
290
- throw new Error("Schema-only branches require a compute endpoint");
291
- }
292
- if (props.type !== EndpointType.ReadWrite) {
293
- throw new Error("Schema-only branches require a read-write compute endpoint");
294
- }
295
- }
296
- const { data } = await retryOnLock(() => props.apiClient.createProjectBranch(props.projectId, {
297
- branch: {
298
- name: props.name,
299
- ...parentProps,
300
- ...(props.schemaOnly ? { init_source: "schema-only" } : {}),
301
- ...(props["expires-at"]
302
- ? {
303
- expires_at: new Date(props["expires-at"]).toISOString(),
304
- }
305
- : {}),
306
- ...(props.protected !== undefined
307
- ? { protected: props.protected }
308
- : {}),
309
- },
310
- endpoints: props.compute
311
- ? [
312
- {
313
- type: props.type,
314
- suspend_timeout_seconds: props.suspendTimeout === 0
315
- ? undefined
316
- : props.suspendTimeout,
317
- ...(props.cu
318
- ? getComputeUnits(props.cu)
319
- : undefined),
320
- },
321
- ]
322
- : [],
323
- annotation_value: props.annotation
324
- ? JSON.parse(props.annotation)
325
- : undefined,
326
- }));
327
- const parent = branches.find((b) => b.id === data.branch.parent_id);
328
- if (parent?.protected) {
329
- log.warning("The parent branch is protected; a unique role password has been generated for the new branch.");
330
- }
331
- const out = writer(props);
332
- out.write(data.branch, {
333
- fields: BRANCH_FIELDS,
334
- title: "branch",
335
- emptyMessage: "No branches have been found.",
336
- });
337
- if (data.endpoints?.length > 0) {
338
- out.write(data.endpoints, {
339
- fields: ["id", "created_at"],
340
- title: "endpoints",
341
- emptyMessage: "No endpoints have been found.",
342
- });
343
- }
344
- if (data.connection_uris?.length) {
345
- out.write(data.connection_uris, {
346
- fields: ["connection_uri"],
347
- title: "connection_uris",
348
- emptyMessage: "No connection uris have been found",
349
- });
350
- }
351
- out.end();
352
- if (props.psql) {
353
- if (!data.connection_uris?.length) {
354
- throw new Error(`Branch ${data.branch.id} doesn't have a connection uri`);
355
- }
356
- const connection_uri = data.connection_uris[0].connection_uri;
357
- const psqlArgs = props["--"];
358
- await psql(connection_uri, psqlArgs, {
359
- mode: props.fallback ? "ts" : "auto",
360
- });
361
- }
188
+ const branches = await props.apiClient.listProjectBranches({ projectId: props.projectId }).then(({ data }) => data.branches);
189
+ const parentProps = (() => {
190
+ if (!props.parent) {
191
+ const branch = branches.find((b) => b.default);
192
+ if (!branch) throw new Error("No default branch found");
193
+ return { parent_id: branch.id };
194
+ }
195
+ if (looksLikeLSN(props.parent)) return { parent_lsn: props.parent };
196
+ if (looksLikeTimestamp(props.parent)) return { parent_timestamp: props.parent };
197
+ if (looksLikeBranchId(props.parent)) return { parent_id: props.parent };
198
+ const branch = branches.find((b) => b.name === props.parent);
199
+ if (!branch) throw new Error(`Branch ${props.parent} not found`);
200
+ return { parent_id: branch.id };
201
+ })();
202
+ if (props.schemaOnly) {
203
+ if (!props.compute) throw new Error("Schema-only branches require a compute endpoint");
204
+ if (props.type !== EndpointType.ReadWrite) throw new Error("Schema-only branches require a read-write compute endpoint");
205
+ }
206
+ const { data } = await retryOnLock(() => props.apiClient.createProjectBranch(props.projectId, {
207
+ branch: {
208
+ name: props.name,
209
+ ...parentProps,
210
+ ...props.schemaOnly ? { init_source: "schema-only" } : {},
211
+ ...props["expires-at"] ? { expires_at: new Date(props["expires-at"]).toISOString() } : {},
212
+ ...props.protected !== void 0 ? { protected: props.protected } : {}
213
+ },
214
+ endpoints: props.compute ? [{
215
+ type: props.type,
216
+ suspend_timeout_seconds: props.suspendTimeout === 0 ? void 0 : props.suspendTimeout,
217
+ ...props.cu ? getComputeUnits(props.cu) : void 0
218
+ }] : [],
219
+ annotation_value: props.annotation ? JSON.parse(props.annotation) : void 0
220
+ }));
221
+ if (branches.find((b) => b.id === data.branch.parent_id)?.protected) log.warning("The parent branch is protected; a unique role password has been generated for the new branch.");
222
+ const out = writer(props);
223
+ out.write(data.branch, {
224
+ fields: BRANCH_FIELDS,
225
+ title: "branch",
226
+ emptyMessage: "No branches have been found."
227
+ });
228
+ if (data.endpoints?.length > 0) out.write(data.endpoints, {
229
+ fields: ["id", "created_at"],
230
+ title: "endpoints",
231
+ emptyMessage: "No endpoints have been found."
232
+ });
233
+ if (data.connection_uris?.length) out.write(data.connection_uris, {
234
+ fields: ["connection_uri"],
235
+ title: "connection_uris",
236
+ emptyMessage: "No connection uris have been found"
237
+ });
238
+ out.end();
239
+ if (props.psql) {
240
+ if (!data.connection_uris?.length) throw new Error(`Branch ${data.branch.id} doesn't have a connection uri`);
241
+ const connection_uri = data.connection_uris[0].connection_uri;
242
+ const psqlArgs = props["--"];
243
+ await psql(connection_uri, psqlArgs, { mode: props.fallback ? "ts" : "auto" });
244
+ }
362
245
  };
363
246
  const rename = async (props) => {
364
- const branchId = await branchIdFromProps(props);
365
- const { data } = await retryOnLock(() => props.apiClient.updateProjectBranch(props.projectId, branchId, {
366
- branch: {
367
- name: props.newName,
368
- },
369
- }));
370
- writer(props).end(data.branch, {
371
- fields: BRANCH_FIELDS,
372
- });
247
+ const branchId = await branchIdFromProps(props);
248
+ const { data } = await retryOnLock(() => props.apiClient.updateProjectBranch(props.projectId, branchId, { branch: { name: props.newName } }));
249
+ writer(props).end(data.branch, { fields: BRANCH_FIELDS });
373
250
  };
374
251
  const setDefault = async (props) => {
375
- const branchId = await branchIdFromProps(props);
376
- const { data } = await retryOnLock(() => props.apiClient.setDefaultProjectBranch(props.projectId, branchId));
377
- writer(props).end(data.branch, {
378
- fields: BRANCH_FIELDS,
379
- });
252
+ const branchId = await branchIdFromProps(props);
253
+ const { data } = await retryOnLock(() => props.apiClient.setDefaultProjectBranch(props.projectId, branchId));
254
+ writer(props).end(data.branch, { fields: BRANCH_FIELDS });
380
255
  };
381
256
  const deleteBranch = async (props) => {
382
- const branchId = await branchIdFromProps(props);
383
- const { data } = await retryOnLock(() => props.apiClient.deleteProjectBranch(props.projectId, branchId));
384
- // A 204 (branch already gone) carries no body; only a 200 returns it.
385
- if (data) {
386
- writer(props).end(data.branch, {
387
- fields: BRANCH_FIELDS,
388
- });
389
- }
257
+ const branchId = await branchIdFromProps(props);
258
+ const { data } = await retryOnLock(() => props.apiClient.deleteProjectBranch(props.projectId, branchId));
259
+ if (data) writer(props).end(data.branch, { fields: BRANCH_FIELDS });
390
260
  };
391
261
  const get = async (props) => {
392
- const branchId = await branchIdFromProps(props);
393
- const { data } = await props.apiClient.getProjectBranch(props.projectId, branchId);
394
- writer(props).end(data.branch, {
395
- fields: BRANCH_FIELDS,
396
- });
262
+ const branchId = await branchIdFromProps(props);
263
+ const { data } = await props.apiClient.getProjectBranch(props.projectId, branchId);
264
+ writer(props).end(data.branch, { fields: BRANCH_FIELDS });
397
265
  };
398
266
  const addCompute = async (props) => {
399
- const branchId = await branchIdFromProps(props);
400
- const computeName = props.name ? { name: props.name } : null;
401
- const { data } = await retryOnLock(() => props.apiClient.createProjectEndpoint(props.projectId, {
402
- endpoint: {
403
- branch_id: branchId,
404
- type: props.type,
405
- ...(props.cu ? getComputeUnits(props.cu) : undefined),
406
- ...computeName,
407
- },
408
- }));
409
- writer(props).end(data.endpoint, {
410
- fields: ["id", "host"],
411
- });
267
+ const branchId = await branchIdFromProps(props);
268
+ const computeName = props.name ? { name: props.name } : null;
269
+ const { data } = await retryOnLock(() => props.apiClient.createProjectEndpoint(props.projectId, { endpoint: {
270
+ branch_id: branchId,
271
+ type: props.type,
272
+ ...props.cu ? getComputeUnits(props.cu) : void 0,
273
+ ...computeName
274
+ } }));
275
+ writer(props).end(data.endpoint, { fields: ["id", "host"] });
412
276
  };
413
277
  const reset = async (props) => {
414
- if (!props.parent) {
415
- throw new Error("Only resetting to parent is supported for now");
416
- }
417
- const branchId = await branchIdFromProps(props);
418
- const { data: { branch: { parent_id }, }, } = await props.apiClient.getProjectBranch(props.projectId, branchId);
419
- if (!parent_id) {
420
- throw new Error("Branch has no parent");
421
- }
422
- const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, branchId, {
423
- source_branch_id: parent_id,
424
- preserve_under_name: props.preserveUnderName || undefined,
425
- }));
426
- writer(props).end(data.branch, {
427
- // need to reset types until we expose reset api
428
- fields: BRANCH_FIELDS_RESET,
429
- });
278
+ if (!props.parent) throw new Error("Only resetting to parent is supported for now");
279
+ const branchId = await branchIdFromProps(props);
280
+ const { data: { branch: { parent_id } } } = await props.apiClient.getProjectBranch(props.projectId, branchId);
281
+ if (!parent_id) throw new Error("Branch has no parent");
282
+ const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, branchId, {
283
+ source_branch_id: parent_id,
284
+ preserve_under_name: props.preserveUnderName || void 0
285
+ }));
286
+ writer(props).end(data.branch, { fields: BRANCH_FIELDS_RESET });
430
287
  };
431
288
  const restore = async (props) => {
432
- const targetBranchId = await branchIdResolve({
433
- branch: props.id,
434
- projectId: props.projectId,
435
- apiClient: props.apiClient,
436
- });
437
- const pointInTime = await parsePointInTime({
438
- pointInTime: props.pointInTime,
439
- targetBranchId,
440
- projectId: props.projectId,
441
- api: props.apiClient,
442
- });
443
- log.info(`Restoring branch ${targetBranchId} to the branch ${pointInTime.branchId} ${(pointInTime.tag === "lsn" && "LSN " + pointInTime.lsn) ||
444
- (pointInTime.tag === "timestamp" &&
445
- "timestamp " + pointInTime.timestamp) ||
446
- "head"}`);
447
- const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, targetBranchId, {
448
- source_branch_id: pointInTime.branchId,
449
- preserve_under_name: props.preserveUnderName || undefined,
450
- ...(pointInTime.tag === "lsn" && { source_lsn: pointInTime.lsn }),
451
- ...(pointInTime.tag === "timestamp" && {
452
- source_timestamp: pointInTime.timestamp,
453
- }),
454
- }));
455
- const writeInst = writer(props).write(data.branch, {
456
- title: "Restored branch",
457
- fields: ["id", "name", "last_reset_at"],
458
- emptyMessage: "No branches have been restored.",
459
- });
460
- const parentId = data.branch.parent_id;
461
- if (props.preserveUnderName && parentId) {
462
- const { data } = await props.apiClient.getProjectBranch(props.projectId, parentId);
463
- writeInst.write(data.branch, {
464
- title: "Backup branch",
465
- fields: ["id", "name"],
466
- emptyMessage: "Backup branch has not been found.",
467
- });
468
- }
469
- writeInst.end();
289
+ const targetBranchId = await branchIdResolve({
290
+ branch: props.id,
291
+ projectId: props.projectId,
292
+ apiClient: props.apiClient
293
+ });
294
+ const pointInTime = await parsePointInTime({
295
+ pointInTime: props.pointInTime,
296
+ targetBranchId,
297
+ projectId: props.projectId,
298
+ api: props.apiClient
299
+ });
300
+ log.info(`Restoring branch ${targetBranchId} to the branch ${pointInTime.branchId} ${pointInTime.tag === "lsn" && "LSN " + pointInTime.lsn || pointInTime.tag === "timestamp" && "timestamp " + pointInTime.timestamp || "head"}`);
301
+ const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, targetBranchId, {
302
+ source_branch_id: pointInTime.branchId,
303
+ preserve_under_name: props.preserveUnderName || void 0,
304
+ ...pointInTime.tag === "lsn" && { source_lsn: pointInTime.lsn },
305
+ ...pointInTime.tag === "timestamp" && { source_timestamp: pointInTime.timestamp }
306
+ }));
307
+ const writeInst = writer(props).write(data.branch, {
308
+ title: "Restored branch",
309
+ fields: [
310
+ "id",
311
+ "name",
312
+ "last_reset_at"
313
+ ],
314
+ emptyMessage: "No branches have been restored."
315
+ });
316
+ const parentId = data.branch.parent_id;
317
+ if (props.preserveUnderName && parentId) {
318
+ const { data } = await props.apiClient.getProjectBranch(props.projectId, parentId);
319
+ writeInst.write(data.branch, {
320
+ title: "Backup branch",
321
+ fields: ["id", "name"],
322
+ emptyMessage: "Backup branch has not been found."
323
+ });
324
+ }
325
+ writeInst.end();
470
326
  };
471
327
  const setExpiration = async (props) => {
472
- // Accept either branch name or id
473
- const branchId = await branchIdFromProps({
474
- ...props,
475
- id: props.branchId,
476
- });
477
- const expiresAt = typeof props.expiresAt === "string"
478
- ? new Date(props.expiresAt).toISOString()
479
- : null;
480
- const { data } = await retryOnLock(() => props.apiClient.updateProjectBranch(props.projectId, branchId, {
481
- branch: {
482
- expires_at: expiresAt,
483
- },
484
- }));
485
- writer(props).end(data.branch, {
486
- fields: BRANCH_FIELDS,
487
- });
328
+ const branchId = await branchIdFromProps({
329
+ ...props,
330
+ id: props.branchId
331
+ });
332
+ const expiresAt = typeof props.expiresAt === "string" ? new Date(props.expiresAt).toISOString() : null;
333
+ const { data } = await retryOnLock(() => props.apiClient.updateProjectBranch(props.projectId, branchId, { branch: { expires_at: expiresAt } }));
334
+ writer(props).end(data.branch, { fields: BRANCH_FIELDS });
488
335
  };
336
+ //#endregion
337
+ export { BRANCH_FIELDS, aliases, builder, command, describe, handler, branches_exports as t };