Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MALTAB] Move type constructor functions from the arrow.type package to arrow package #36874

Closed
sgilmore10 opened this issue Jul 25, 2023 · 1 comment · Fixed by #36875
Closed

[MALTAB] Move type constructor functions from the arrow.type package to arrow package #36874

sgilmore10 opened this issue Jul 25, 2023 · 1 comment · Fixed by #36875
Assignees
@sgilmore10
Labels
Component: MATLAB Type: enhancement
Milestone
14.0.0

Comments

@sgilmore10
Copy link
Member

Describe the enhancement requested

When working on PR #36855, we realized it would be better to place all recommended public/user-facing APIs in the top-level arrow package. That's why we added the function arrow.field in the top-level arrow package instead of under arrow.type, even though the Field class is within arrow.type package. We should move the type constructor functions (arrow.type.uint8, arrow.type.timestamp, etc) into the top-level arrow package.

Component(s)

MATLAB
@sgilmore10
Copy link
Member Author

take

@github-actions github-actions bot mentioned this issue Jul 25, 2023
Merged
kevingurney pushed a commit that referenced this issue Jul 26, 2023
@sgilmore10
GH-36874: [MATLAB] Move type constructor functions from the `arrow.ty…
32659a2 
…pe` package to `arrow` package (#36875)

### Rationale for this change

When working on PR #36855, we realized it would be better to place all recommended public/user-facing APIs in the top-level `arrow` package. That's why we added the function `arrow.field` in the top-level `arrow` package instead of under `arrow.type`, even though the `Field` class is within `arrow.type` package.

### What changes are included in this PR?

1. Moved the type constructor functions (`arrow.type.int8()`, `arrow.type.timestamp()`, etc) from the `arrow.type` package to the `arrow package`. 

**Example: Old Way to Create a `Timestamp` Object:**

```matlab
>> type = arrow.type.timestmap(TimeUnit="nanosecond");
```

**Example: New Way to Create a `Timestamp` Object:**

```matlab
>> type = arrow.timestmap(TimeUnit="nanosecond");
```

### Are these changes tested?

Changes are covered by existing tests.

### Are there any user-facing changes?

Yes. 

NOTE: This is a breaking change, but the MATLAB interface is not yet stable.
* Closes: #36874

Authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
@kevingurney kevingurney added this to the 14.0.0 milestone Jul 26, 2023
R-JunmingChen pushed a commit to R-JunmingChen/arrow that referenced this issue Aug 20, 2023
@sgilmore10 @R-JunmingChen
apacheGH-36874: [MATLAB] Move type constructor functions from the `ar…
08cab78 
…row.type` package to `arrow` package (apache#36875)

### Rationale for this change

When working on PR apache#36855, we realized it would be better to place all recommended public/user-facing APIs in the top-level `arrow` package. That's why we added the function `arrow.field` in the top-level `arrow` package instead of under `arrow.type`, even though the `Field` class is within `arrow.type` package.

### What changes are included in this PR?

1. Moved the type constructor functions (`arrow.type.int8()`, `arrow.type.timestamp()`, etc) from the `arrow.type` package to the `arrow package`. 

**Example: Old Way to Create a `Timestamp` Object:**

```matlab
>> type = arrow.type.timestmap(TimeUnit="nanosecond");
```

**Example: New Way to Create a `Timestamp` Object:**

```matlab
>> type = arrow.timestmap(TimeUnit="nanosecond");
```

### Are these changes tested?

Changes are covered by existing tests.

### Are there any user-facing changes?

Yes. 

NOTE: This is a breaking change, but the MATLAB interface is not yet stable.
* Closes: apache#36874

Authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this issue Nov 13, 2023
@sgilmore10 @loicalleyne
apacheGH-36874: [MATLAB] Move type constructor functions from the `ar…
3005744 
…row.type` package to `arrow` package (apache#36875)

### Rationale for this change

When working on PR apache#36855, we realized it would be better to place all recommended public/user-facing APIs in the top-level `arrow` package. That's why we added the function `arrow.field` in the top-level `arrow` package instead of under `arrow.type`, even though the `Field` class is within `arrow.type` package.

### What changes are included in this PR?

1. Moved the type constructor functions (`arrow.type.int8()`, `arrow.type.timestamp()`, etc) from the `arrow.type` package to the `arrow package`. 

**Example: Old Way to Create a `Timestamp` Object:**

```matlab
>> type = arrow.type.timestmap(TimeUnit="nanosecond");
```

**Example: New Way to Create a `Timestamp` Object:**

```matlab
>> type = arrow.timestmap(TimeUnit="nanosecond");
```

### Are these changes tested?

Changes are covered by existing tests.

### Are there any user-facing changes?

Yes. 

NOTE: This is a breaking change, but the MATLAB interface is not yet stable.
* Closes: apache#36874

Authored-by: Sarah Gilmore <sgilmore@mathworks.com>
Signed-off-by: Kevin Gurney <kgurney@mathworks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sgilmore10 sgilmore10

Labels
Component: MATLAB Type: enhancement
Projects
None yet
Milestone
14.0.0
2 participants
@kevingurney @sgilmore10